Atari Forever 4/Atari Forever 4.zip/Atari Forever 4.iso/SERIE_S/S_908/UDO.ASC

Text File | 1998-03-14 | 252KB | 7,644 lines

                           Die Anleitung zu

                                 UDO

                              Release 5
                            8. April 1996

                                 von

                            Dirk Hagedorn
                           In der Esmecke 9
                           D-59846 Sundern

                     MausNet: Dirk Hagedorn @ MK2



Inhaltsverzeichnis
==================

 1  Einführung
    1.1  Vorwort
    1.2  Was kann UDO und was nicht?
    1.3  Benötigen Sie UDO?
    1.4  Shareware
    1.5  Was kostet UDO?
    1.6  Registrierung
    1.7  UDOs Entstehungsgeschichte
    1.8  Kontaktadresse
    1.9  Danksagung
    1.10  Über diese Anleitung

 2  Rechtliche Informationen
    2.1  Copyright
    2.2  Haftungsausschluß
    2.3  Warenzeichen

 3  Installation
    3.1  Installation der Amgia-Version
    3.2  Installation der TOS- und GEM-Version
    3.3  Installation der DOS-Version
    3.4  Installation der HP-UX-Version
    3.5  Installation der Linux-Version
    3.6  Installation der Macintosh-Version

 4  Bedienung
    4.1  Kommandozeilenversion
         4.1.1  Kommandozeilen-Optionen
         4.1.2  Environment
         4.1.3  Rückgabewerte der Kommandozeilenversion
    4.2  GEM-Version
         4.2.1  Die GEM-Version kurz vorgestellt
         4.2.2  GEM-Hauptdialog
         4.2.3  Die Menüzeile des GEM-Hauptdialogs
         4.2.4  GEM-Dialog `Einstellungen'
         4.2.5  GEM-Dialog `Externe Programme'

 5  Die UDO-Syntax
    5.1  Quelltext-Beispiel
    5.2  Grundlagen
         5.2.1  Let's talk about text, Baby!
         5.2.2  Kommandos, Schalter und Platzhalter
         5.2.3  Kommentare
         5.2.4  Vorspann und Hauptteil
         5.2.5  Umgebungen
    5.3  Gliederung
         5.3.1  Titelseite
         5.3.2  Inhaltsverzeichnisse
         5.3.3  Kapitel, Abschnitte und Unterabschnitte
         5.3.4  Anhang
    5.4  Texthervorhebungen
         5.4.1  Zentrieren von Zeilen
         5.4.2  Einrücken von Absätzen
         5.4.3  Einfache Aufzählungen
         5.4.4  Numerierte Aufzählungen
         5.4.5  Beschreibende Aufzählungen
         5.4.6  Listen
         5.4.7  Vorformatierter Text
         5.4.8  Fußnoten
         5.4.9  Schriftarten
         5.4.10  Tabellen
    5.5  Sonderzeichen
         5.5.1  Umwandlung von 8-bit-Zeichen
         5.5.2  Doppelte Anführungszeichen
         5.5.3  Doppelte Apostrophe
         5.5.4  Feste Leerzeichen
         5.5.5  Gedankenstriche
    5.6  Silbentrennung
         5.6.1  Lokales Setzen von Trennstellen
         5.6.2  Globales Setzen von Trennstellen
         5.6.3  Hinweise auf zu kurze Zeilen
    5.7  Bilder
         5.7.1  *.img & ST-Guide
         5.7.2  *.img & Lindner-TeX
         5.7.3  *.img & CS-TeX/MultiTeX
         5.7.4  *.msp & emTeX
         5.7.5  *.pcx & emTeX
         5.7.6  *.gif & HTML
         5.7.7  *.bmp & WinHelp
    5.8  Miszellaneen
         5.8.1  Makros
         5.8.2  Definitionen
         5.8.3  Sprungmarken
         5.8.4  Querverweise
         5.8.5  Indizes
         5.8.6  Formatspezifisches
         5.8.7  Verteilte Dokumente

Anhang
======

 A  FAQ
    A.1  Allgemeine Fragen
    A.2  Fragen zum ASCII-Format
    A.3  Fragen zum HTML-Format
    A.4  Fragen zum Manualpage-Format
    A.5  Fragen zum LaTeX-Format
    A.6  Fragen zum Linuxdoc-SGML-Format
    A.7  Fragen zum Pure-C-Help-Format
    A.8  Fragen zum Rich Text Format
    A.9  Fragen zum ST-Guide-Format
    A.10  Fragen zum Texinfo-Format
    A.11  Fragen zum Turbo-Vision-Help-Format
    A.12  Fragen zum WinHelp-Format

 B  Bekannte Fehler

 C  Fehlermeldungen
    C.1  Fehlermeldungen des Programms
    C.2  Meldungen aufgrund Syntaxfehlern

 D  Dies & das
    D.1  Zahlen und Fakten
    D.2  Entwicklungsumgebung
    D.3  Erzeugte Dateien

 E  Historie
    E.1  In letzter Minute
    E.2  Release 5
    E.3  Release 4
    E.4  Release 3

 F  Befehlsindex
    F.1  A...
         F.1.1  !=asc
         F.1.2  !alias
         F.1.3  !asc
         F.1.4  !author
         F.1.5  !authorimage
         F.1.6  !autoref
         F.1.7  (!alpha)
    F.2  B...
         F.2.1  !begin_appendix
         F.2.2  !begin_description
         F.2.3  !begin_document
         F.2.4  !begin_enumerate
         F.2.5  !begin_itemize
         F.2.6  !begin_quote
         F.2.7  !begin_raw
         F.2.8  !begin_table
         F.2.9  !begin_verbatim
         F.2.10  !begin_xlist
         F.2.11  !bigskip
         F.2.12  !break
         F.2.13  (!B)...(!b)
         F.2.14  (!beta)
    F.3  C...
         F.3.1  !chapterimage
         F.3.2  !code_ansi
         F.3.3  !code_ascii
    F.4  D...
         F.4.1  !date
         F.4.2  !define
    F.5  E...
         F.5.1  !else
         F.5.2  !email
         F.5.3  !end_appendix
         F.5.4  !end_description
         F.5.5  !end_document
         F.5.6  !end_enumerate
         F.5.7  !end_itemize
         F.5.8  !end_quote
         F.5.9  !end_raw
         F.5.10  !end_table
         F.5.11  !end_verbatim
         F.5.12  !end_xlist
         F.5.13  !endif
         F.5.14  !english
    F.6  F...
         F.6.1  !french
         F.6.2  !fussy
         F.6.3  (!F)...(!f)
         F.6.4  (!file)
    F.7  G...
         F.7.1  !german
         F.7.2  (!G)...(!g)
         F.7.3  (!grin)
    F.8  H...
         F.8.1  !=html
         F.8.2  !hline
         F.8.3  !html
         F.8.4  !html_merge_nodes
         F.8.5  !html_merge_subnodes
         F.8.6  !html_merge_subsubnodes
         F.8.7  !html_use_xlist
         F.8.8  !htmlname
         F.8.9  !hyphen
    F.9  I...
         F.9.1  !=info
         F.9.2  !ifdest
         F.9.3  !iflang
         F.9.4  !image
         F.9.5  !include
         F.9.6  !index
         F.9.7  !info
         F.9.8  !item
         F.9.9  !item []
         F.9.10  (!I)...(!i)
         F.9.11  (!idx ...)
         F.9.12  (!ilink ...)
         F.9.13  (!img ...)
    F.10  L...
         F.10.1  !=ldoc
         F.10.2  !label
         F.10.3  !ldoc
         F.10.4  !list_parsep
         F.10.5  (!LaTeX)
         F.10.6  (!LaTeXe)
         F.10.7  (!laugh)
         F.10.8  (!link ...)
    F.11  M...
         F.11.1  !=man
         F.11.2  !macro
         F.11.3  !maketitle
         F.11.4  !man
         F.11.5  !man_lpp
         F.11.6  !man_type
         F.11.7  !medskip
    F.12  N...
         F.12.1  !newpage
         F.12.2  !no_bottomlines
         F.12.3  !no_effects
         F.12.4  !no_headlines
         F.12.5  !no_images
         F.12.6  !no_numbers
         F.12.7  !no_quotes
         F.12.8  !no_umlaute
         F.12.9  !no_xlinks
         F.12.10  !node
         F.12.11  !node*
         F.12.12  (!N)...(!n)
         F.12.13  (!nl)
    F.13  O...
         F.13.1  (!O)...(!o)
    F.14  P...
         F.14.1  !=pch
         F.14.2  !pch
         F.14.3  !pnode
         F.14.4  !pnode*
         F.14.5  !program
         F.14.6  !programimage
         F.14.7  !psubnode
         F.14.8  !psubnode*
         F.14.9  !psubsubnode
         F.14.10  !psubsubnode*
         F.14.11  (!plink ...)
    F.15  R...
         F.15.1  !=rtf
         F.15.2  !rinclude
         F.15.3  !rtf
         F.15.4  !rtf_monofont
         F.15.5  !rtf_propfont
    F.16  S...
         F.16.1  !=stg
         F.16.2  !sloppy
         F.16.3  !smallskip
         F.16.4  !stg
         F.16.5  !stg_no_database
         F.16.6  !street
         F.16.7  !subnode
         F.16.8  !subnode*
         F.16.9  !subsubnode
         F.16.10  !subsubnode*
         F.16.11  !subsubtoc
         F.16.12  !subtoc
         F.16.13  (!S)...(!s)
         F.16.14  (!short_today)
    F.17  T...
         F.17.1  !=tex
         F.17.2  !tableofcontents
         F.17.3  !tex
         F.17.4  !tex_2e
         F.17.5  !tex_dpi
         F.17.6  !tex_emtex
         F.17.7  !tex_lindner
         F.17.8  !tex_strunk
         F.17.9  !tex_verb
         F.17.10  !title
         F.17.11  !toc
         F.17.12  !toc_offset
         F.17.13  !town
         F.17.14  (!T)...(!t)
         F.17.15  (!TeX)
         F.17.16  (!today)
    F.18  U...
         F.18.1  !use_about_udo
         F.18.2  !use_ansi_tables
         F.18.3  !use_auto_subsubtocs
         F.18.4  !use_auto_subtocs
         F.18.5  !use_chapter_images
         F.18.6  !use_formfeed
         F.18.7  !use_short_toc
         F.18.8  !use_style_book
         F.18.9  (!U)...(!u)
    F.19  V...
         F.19.1  !verbatim_no_umlaute
         F.19.2  !version
         F.19.3  !vinclude
         F.19.4  (!V)...(!v)
    F.20  W...
         F.20.1  !=win
         F.20.2  !win
         F.20.3  !win_html_look
         F.20.4  !win_propfont
    F.21  X...
         F.21.1  (!xlink ...)



Kapitel 1

Einführung
**********


1.1  Vorwort
============

Willkommen zu UDO!

Vor Ihnen liegt (oder flimmert) die ziemlich überarbeitete Dokumen-
tation zum ziemlich überarbeiteten Programm namens UDO, geschrieben
von einem völlig überarbeiteten Autor.

Wer generell keine Handbücher lesen möchte, weil er denkt, daß er
auch so mit einem Programm klar kommt, dem sei gesagt, daß er das
Programm `UDO' sicherlich auch so bedienen können wird. Aber das
Format `UDO' und die Möglichkeiten, die UDO bietet, werden dann für
lange Zeit verborgen bleiben, falls man diese Anleitung nicht einmal
überfliegen möchte.

Daher empfehle ich dringend, zumindest diese Einführung durchzulesen.
Dann werden Sie erfahren, warum es UDO eigentlich gibt, ob Sie UDO
überhaupt benötigen, welche Möglichkeiten Ihnen UDO bietet und (lei-
der auch) für welche Zwecke UDO nur wenig oder gar nicht geeignet
ist.

Falls Sie nach dieser Einführung ein Interesse an UDO gewonnen haben
sollten, so empfehle ich Ihnen, einen Blick auf den Beispiel-Quell-
text im Kapitel "Die UDO-Syntax" zu werfen. Mit den Informatio-
nen, die Sie bei diesem Beispiel erhalten, können Sie bereits eigene
Quelltexte erstellen. Vertiefende Informationen erhalten Sie
dann in den folgenden Abschnitten dieses Kapitels.


An der Versionsnummer können Sie erkennen, daß UDO noch lange nicht
alle Features bietet, die ich noch einbauen möchte. Trotzdem habe ich
mich zum fünften Mal dazu hinreißen lassen, UDO zu veröffentlichen,
da es bereits umfangreiche Möglichkeiten bietet, die fast allen
Ansprüchen gerecht werden.

In der Hoffnung, daß UDO für Sie genau wie für mich selbst eine
unverzichtbare Hilfe wird, Sie mehr Zeit für die wesentlichen Dinge
bekommen und meine Mühe honorieren werden,

Dirk Hagedorn

Sundern, den 8. April 1996


1.2  Was kann UDO und was nicht?
================================

UDO wurde entwickelt, um die Erstellung von Anleitungen zu Compu-
terprogrammen oder vergleichbaren Dokumentationen zu vereinfachen,
die in mehr als einem Format benötigt werden.

UDO kann aber auch dazu dienen, lediglich ein Format auszugeben, mit
dem man sich nicht so recht anfreunden kann. So ist es für Anfänger
sicherlich einfacher, die Syntax von UDO zu begreifen als die von
HTML oder LaTeX, denn bei letzteren muß man höllisch aufpassen, daß
man nicht unerlaubte Zeichen im Quelltext einbaut, wogegen UDO auch
mit Umlauten klarkommt und diese automatisch an das jeweilige Ausga-
beformat anpaßt.

Bei alledem ist UDO multilingual, d.h. Sie können deutsche, englische
oder französische Texte erzeugen, und UDO wird dabei die jeweils
passenden Begriffe für "Inhaltsverzeichnis", "Anhang", "Abbildung",
"Tabelle" ausgeben oder das Datum im Format der gewählten Sprache
darstellen.

Die Syntax von UDO ist dabei sehr leicht zu erlernen. Bitte er-
schrecken Sie nicht, falls Sie die zahllosen Befehle im Befehls-
index sehen, denn zur Erstellung kleinerer Texte müssen Sie lediglich
eine Handvoll von Befehlen kennen!

Haben Sie einen Quelltext erstellt, so können Sie diesen

  1. ins LaTeX-Format,
  2. ins Rich Text Format (RTF),
  3. in die Hypertext Markup Language (HTML),
  4. in einen GNU-Texinfo-Quelltext,
  5. in einen ST-Guide-Quelltext,
  6. in Pure-C-Help-Quelltext,
  7. in einen WinHelp-Quelltext,
  8. in einen Turbo-Vision-Help-Quelltext,
  9. ins Linuxdoc-SGML-Format,
 10. in eine Manualpage und natürlich
 11. ins ASCII-Format

umwandeln. UDO erzeugt dabei größtenteils keine `fertigen' Dokumente.
In aller Regel muß das, was UDO erzeugt, erst noch durch ein format-
zugehöriges Programm weiterverarbeitet werden (*.rtf durch eine
Textverarbeitung, *.stg durch hcp.ttp, *.hpj durch HC31.EXE etc.).


UDO versucht, dem Verfasser des Textes soviel Arbeit wie möglich
abzunehmen. Neben der reinen Umwandlung bietet UDO daher je nach Aus-
gabeformat sinnvolle Nützlichkeiten wie

   ∙ automatische Generierung von Titelseiten, Kopfzeilen, Fußnoten,
     Inhaltsverzeichnissen,
   ∙ automatische Kapitelnumerierung,
   ∙ Tabellensatz,
   ∙ automatische Referenzierung,
   ∙ Unterstützung verschiedenster Schriftarten,
   ∙ automatische Umwandlung von Umlauten und Sonderzeichen,
   ∙ umfangreiche Formatierungsmöglichkeiten mit Erstellung von
     Aufzählungen, Listen, zentrierten oder eingerückten Text,
   ∙ automatisches Einbinden von Bildern sowie
   ∙ automatischen Zeilenumbruch mit halbautomatischer
     Silbentrennung.


UDO hat so seine Stärken und Schwächen. Die Umwandlung ins ASCII-,
ST-Guide-, LaTeX- und WinHelp-Format gehören - historisch bedingt -
zu den Stärken. Ausgabeformate wie Texinfo, Turbo-Vision-Help und
Linuxdoc-SGML (dieses Format wurde am 27. März 1996 nach Durchlesen
des User's Guide innerhalb von 2 Stunden eingebaut) werden erst seit
sehr kurzer Zeit angeboten und hier gibt es sicherlich noch viel zu
tun. Erwarten Sie bitte hier keine Wunder.

Einige Dinge stehen bei mir und sicherlich auch bei etlichen Benut-
zern ganz oben auf der Wunschliste. Einige dieser Dinge werden si-
cherlich in UDO6 eingebaut: Die automatische Erzeugung eines Index-
registers, die Ausgabe eines Abbildungs- und Tabellenverzeichnisses,
die Ausgabe der Inhaltsverzeichnisse als Unordered Lists bei HTML,
die Möglichkeit, Texte systemweit weiterzugeben, ohne diese vor-
her durch GNU-recode umzuwandeln.


Die Erstellung von komplexen Dokumenten wie Zeitschriften ist mit UDO
nicht möglich, da z.B. Bilder nicht frei positioniert werden können
und kein Spaltensatz erzeugt werden kann.

Es gibt darüber hinaus noch ein paar Dinge, die UDO nicht kann und in
absehbarer Zeit auch nicht können wird. Dazu zählen

   ∙ Blocksatz,
   ∙ die freie Plazierung von Bildern,
   ∙ eine vollautomatische Silbentrennung und
   ∙ die Erzeugung von Binärformaten.


1.3  Benötigen Sie UDO?
=======================

Falls Sie eine oder mehrere der folgenden Fragen mit Ja beantworten,
dann dürfte es sich für Sie lohnen, UDO einmal genauer anzusehen.
Falls Sie keine Frage mit Ja beantworten sollten, dann dürfte es sehr
wahrscheinlich so sein, daß ein Weiterlesen dieser Dokumentation oder
der Einsatz von UDO für Sie überflüssig ist.

   ∙ Sie programmieren und benötigen neben der obligatorischen ASCII-
     Anleitung noch eine Onlinehilfe in Form eines ST-Guide-Hyper-
     textes, einer Hilfedatei für Windows oder einer Hilfe-Datei für
     Borlands Turbo-Vision?

   ∙ Sie programmieren und benötigen neben der ASCII-Anleitung noch
     ein gedrucktes Handbuch, welches Sie mit LaTeX oder einer Text-
     verarbeitung, die das Rich Text Format (korrekt!) importieren
     kann, setzen möchten?

   ∙ Sie sind der Autor einer Library für Pure-C auf dem Atari und
     benötigen eine Beschreibung der Routinen als Onlinehilfe für
     Pure-C und als ST-Guide-Hypertext?

   ∙ Sie benötigen nur eine ASCII-Anleitung, möchten sich aber nicht
     immer selbst um den Zeilenumbruch, die Kapitelnumerierung und
     die Erstellung des Inhaltsverzeichnisses kümmern?

   ∙ Sie möchten einen Hypertext im World Wide Web anbieten, Sie
     besitzen aber keinen leistungsfähigen HTML-Editor, der sich wie
     UDO um eine automatische Referenzierung, Umlautwandlung oder die
     kapitelweise Aufteilung des Hypertextes kümmern kann?

   ∙ Sie möchten einen Hilfstext für ein Windows-Programm anbieten,
     haben aber keine Lust, den zwanzigfachen Preis für ein Tool zu
     bezahlen, das nur wenig mehr kann als UDO?

   ∙ Sie haben einen Text mit allgemeinem Inhalt verfaßt und möchten
     diesen auch Personen zugänglich machen, die nicht das Betriebs-
     system benutzen, welches Sie selbst einsetzen?

Und, konnten Sie eine Frage mit Ja beantworten? Schön! Ansonsten: Es
war nett, daß Sie einmal hereingeschaut haben. ;-)


1.4  Shareware
==============

UDO ist Shareware. Dies bedeutet folgendes:

   ∙ Sie dürfen UDO genau zwei Wochen lang testen.

   ∙ Texte, die während der Probezeit erstellt wurden, dürfen der
     Öffentlichkeit nicht zugänglich gemacht werden.

   ∙ Nach Ablauf der zwei Wochen müssen Sie sich entscheiden, ob Sie
     sich für UDO registrieren lassen oder ob Sie UDO nicht benutzen
     möchten.

   ∙ Wenn Sie sich registrieren lassen möchten, so lesen Sie bitte
     unter "Registrierung" weiter.

   ∙ Sollten Sie sich nach Ablauf der Probezeit nicht für UDO regis-
     trieren lassen, müssen Sie UDO samt allen zugehörigen Dateien
     von Ihrem Datenträger löschen.

   ∙ Benutzen Sie UDO nach Ablauf der Probezeit immer noch, so ar-
     beiten mit einer Raubkopie!

UDO ist in der/den Kommandozeilenversion(en) nicht eingeschränkt. Die
GEM-Version ist nur leicht, nicht funktional eingeschränkt. Da die
Hauptanwendergruppe für UDO größtenteils aus Handbuch- und Programm-
autoren bestehen dürfte und ich mir hier eine größere Zahlungsmoral
erhoffe als beim großen Rest der heimlichen Anwenderschar, habe ich
auf großartige Einschränkungen verzichtet.

Sollte ich wider Erwarten kaum Resonanz in Form von Registrierungen
bekommen, werde ich entweder

  1. UDO zur Crippleware machen (etwa mit häßlichen Warteschleifen,
     begrenzten Dokumentgrößen, vertauschten Buchstaben in der Ziel-
     datei, ...) oder

  2. neue Versionen nicht mehr veröffentlichen und nur noch an re-
     gistrierte Anwender herausgeben oder

  3. die Weiterentwicklung von UDO komplett einstellen.

Das sind keine leeren Drohungen, das ist mein Ernst! Ich bin in der
Vergangenheit bereits oft genug enttäuscht worden. Manche mögen
angesichts dieser Worte schmunzeln, ich kann darüber gar nicht mehr
lachen!


1.5  Was kostet UDO?
====================

Sie können mir glauben, daß ich mir fast den Kopf zerbrochen habe,
wieviel ich für dieses Programm verlangen kann. Ich möchte den Preis
nicht verraten, den ich eigentlich für UDO verlangen müßte, da dieser
einfach überhalb der Grenze liegen würde, den heutzutage der Durch-
schnittsbenutzer bereit ist, für Shareware zu bezahlen. Ich denke
aber, daß ich mit dem jetzigen Preis ein guten Kompromiß zwischen
"Traum und Realität" gefunden habe, und hoffe, daß Ihnen UDO dieses
Geld wert ist.

Die Höhe der Sharewaregebühr hängt davon ab, ob Sie UDO im privaten
oder kommerziellen Umfeld einsetzen werden:

 Benutzung für private Zwecke:

     Der Preis für eine Lizenz von UDO beträgt 40 DM für einen pri-
     vaten Nutzer. Als privater Nutzer gilt, wer mit UDO Anleitun-
     gen oder sonstige Texte zu Produkten erstellt, deren Ver-
     kaufspreis niedriger als 100 DM ist. Dazu zählen automatisch
     alle Autoren, die Programme nur als Freeware, Public Domain oder
     Shareware (mit einer Sharewaregebühr kleiner als 100 DM) anbie-
     ten. Die Sharewaregebühr muß einmalig entrichtet werden, will
     meinen die Benutzung von UDO durch einen Benutzer auf verschie-
     denen Betriebssystemen ist nach einmaliger Entrichtung
     gestattet.

 Benutzung für kommerzielle Zwecke:

     Der Preis für eine Einzelplatzlizenz von UDO beträgt 100 DM für
     einen kommerziellen Nutzer. Als kommerzieller Nutzer gilt, wer
     mit UDO Anleitungen oder sonstige Texte zu einem oder mehreren
     Produkt(en) erstellt, deren Verkaufspreis 100 DM oder höher ist.
     Jede weitere Lizenz, die erworben werden muß, falls UDO inner-
     halb einer Firma oder Institution von mehreren Benutzern einge-
     setzt wird, kostet 40 DM.

Alle Preise verstehen sich inklusive der gesetzlich vorgeschriebenen
Mehrwertsteuer.


Sollten Sie im Nachhinein feststellen, daß Sie UDO kommerziell nut-
zen, obwohl Sie nur die Sharewaregebühr für die Privatnutzung bezahlt
haben, so ist die Bezahlung des Differenzbetrages zwingend
erforderlich!


Eine Bitte an Privatbenutzer, die Ihre registrierte Version auch am
Arbeitsplatz einsetzen: Reden Sie doch einmal mit Ihrem EDV-Leiter
oder notfalls mit Ihrem Chef, ob es der Finanzetat nicht ermöglicht,
auch eine oder mehrere kommerzielle Lizenz(en) von UDO zu erwerben.
Danke!


1.6  Registrierung
==================

Die Sharewaregebühr, deren Höhe Sie im Kapitel "Was kostet UDO?"
ermitteln können, kann man mir folgendermaßen zukommen lassen:

  1. Durch Zusendung eines Verrechnungsschecks an folgende Adresse:

         Dirk Hagedorn
         In der Esmecke 9
         59846 Sundern
         Deutschland

     Dies ist die von mir am liebsten gesehene Bezahlungsweise, da
     sie am unkompliziertesten und sichersten ist.

  2. Durch Überweisung auf mein Konto. Geben Sie dabei bitte mög-
     lichst Ihre komplette Anschrift auf dem Überweisungsträger und
     "UDO" als Stichwort an, damit ich die Überweisung korrekt zu-
     ordnen kann! Zusätzlich sollte man eine Postkarte oder eine E-
     Mail an mich schicken, anhand derer man mich informiert, daß man
     die Überweisung vorgenommen hat und anhand derer ich sicher Ihre
     Anschrift, die zur Erzeugung des Schlüssels für die GEM-Version
     benötigt wird, erkennen kann. Leider wird gerade letzteres gerne
     vergessen, genauso wie die Banken, die nicht immer alle Infor-
     mationen des Überweisungsträgers weiterleiten.

     Meine Bankverbindung lautet:

         Dirk Hagedorn
         Konto 3 561 164
         Sparkasse Arnsberg-Sundern
         Bankleitzahl 466 500 05

  3. Durch Zusendung von Bargeld, am besten per Einschreiben mit
     Rückschein, an obige Adresse.

Nachdem die Sharewaregebühr eingetroffen ist, erhält man von mir eine
Quittung, um den Kauf von UDO steuerlich absetzen zu können, sowie
einen persönlichen Schlüssel, mit dem die Einschränkungen der GEM-
Version aufgehoben werden können.

Übrigens: Auf Wünsche von registrierten Benutzern wird besondere
Rücksicht genommen, und falls diese Wünsche nicht zu ausgefallen
sind, werden diese fast immer implementiert. Das ist keine leere
Worthülse, sondern wurde in der Vergangenheit mehrfach praktiziert.


1.7  UDOs Entstehungsgeschichte
===============================

Irgendwann im Herbst 1994 hatte ich mehrere kleinere Programme ge-
schrieben, für die ich je eine ASCII-Anleitung, einen Hypertext für
den ST-Guide und ein gedrucktes Handbuch benötigte.

Ich begann jeweils damit, zunächst die ASCII-Anleitung zu schreiben,
in eine Kopie Hypertextkommandos einzufügen und schließlich die
ASCII-Anleitung in eine Textverarbeitung zu importieren und dort zu
setzen. Schnell stellte sich heraus, daß dieser Weg ziemlich mühsam
war, denn bei auch nur kleinen Änderungen mußten diese in gleich drei
Dateien durchgeführt werden. So konnte es einfach nicht weitergehen.

Nachdem die Anleitungen für die genannten Programme fertig waren,
machte ich mir ein paar Gedanken, wie man es anstellen könnte, nur
noch eine Anleitung schreiben zu müssen. Dabei kam dann ein kleines
Tool namens "STG2ASC" heraus, welches aus einem ST-Guide-Hypertext-
Quelltext die HCP-Kommandos herausfilterte und eine reine ASCII-
Anleitung ausspuckte. Dieses Tool war mir jedoch nicht leistungsfähig
genug, so daß ich es nicht veröffentlicht habe (Dirk Haun hat daraus
allerdings noch ein Modul für Zeig's mir erstellt).

Im Januar 1995 war immer noch keine befriedigende Lösung gefunden.
Nach ein paar weiteren Überlegungen kam mir die Idee, eine neue
Syntax zu entwerfen, welcher ich den Projektnamen "UDO" (als Abkür-
zung für Universal DOcument) gab. Die Syntax sollte leicht zu erler-
nen aber trotzdem flexibel genug sein, und so beschloß ich, mich an
der LaTeX- und der HCP-Syntax zu orientieren. Parallel dazu wurde das
passende Programm entwickelt, welches Textdateien, die in dieser
speziellen Syntax verfaßt wurden, in ASCII-Texte, ST-Guide- und
LaTeX-Quelltexte umwandeln konnte: UDO1 war geboren!

Mittlerweile ist mehr als ein Jahr vergangen und UDO hat sich von
einem simplen Tool für Atari-Rechner zu einem leistungsfähigen,
systemunabhängigen Programm entwickelt. Von einem "Konvertierpro-
gramm" zu sprechen, trifft eigentlich schon lange nicht mehr zu, den
UDO benutzt intensiv die jeweiligen Möglichkeiten eines Ausgabe-
formates, von denen UDO derzeit fast ein Dutzend unterstützt.


1.8  Kontaktadresse
===================

Falls Sie sich für UDO registrieren lassen möchten, Anmerkungen oder
Fragen haben, Anregungen oder Fehlermeldungen mitteilen möchten, so
wenden Sie sich bitte an eine der untenstehenden Adressen.

Falls es sich irgendwie vermeiden läßt, versuchen Sie bitte, mich
nicht anzurufen, sondern mir stattdessen ein Fax, einen Brief oder
eine EMail zu schicken. Nicht, daß ich ungerne telefoniere, aber
glauben Sie es mir, daß ich telefonisch kaum erreichbar bin.

 Anschrift:      Dirk Hagedorn
                 In der Esmecke 9
                 59846 Sundern
                 Deutschland

 Telefax:        [phone]

 MausNet:        Dirk Hagedorn @ MK2 (keine Mails > 16 KB)

 America Online: [e-mail]

 World Wide Web: http://members.aol.com/DirkHage/www/index.htm

 Bankverbindung: Konto 3 561 164
                 Sparkasse Arnsberg-Sundern
                 Bankleitzahl 466 500 05


1.9  Danksagung
===============

Ich möchte mich an dieser Stelle bei folgenden, namentlich sortierten
Personen bedanken, ohne deren tatkräftige Unterstützung UDO nie zu
dem geworden wäre, was es heute ist.

Vielen Dank daher an...

 Frank Baumgart für die Compilierung der Linux-Version und seinen
     Mut, UDO bereits in dem Stadium zu testen, als es noch wie wild
     Coredumps produzierte,

 Denesh Bhabuta für den Support in England,

 Andrea Bierhoff, die den Spruch "ich muß da noch etwas erledigen"
     sicherlich nicht mehr hören kann,

 Jens Brüggemann für einige interessante Tips in Sachen "Cachen von
     Dateien", die immer noch in meinem Kopf herumspuken,

 Volker Burggräf für die Tips bezüglich des WinHelp-Formats,

 Alexander Clauss für seinen HTML-Browser CAB, seine Hinweise bezüg-
     lich des HTML-Formats und das Testen der HP-UX-Version,

 Dirk Haun für seine vielen konstruktiven Kritiken und Wünsche sowie
     für vieles mehr,

 Peter Klasen, der als erster registrierter Benutzer in die Ge-
     schichte von UDO eingehen wird und dessen Postbote immer noch
     nicht weiß, daß er auf der anderen Straßenseite wohnt,

 Martin Loos für die große Mühe, die er sich mit der Verwaltung der
     UDO-Mailingliste macht,

 Andreas Pietsch für seine GEM-Library `SysGem', mit der die Pro-
     grammierung der GEM-Version in knapp drei Tagen erledigt war,

 Georg Sauerwald für die Ermöglichung der Tests bezüglich des RTF-
     Imports in That's Write (welches RTF nicht korrekt importiert),

 Andreas Schrell für seine kompetenten Hinweise bezüglich der LaTeX-
     Ausgabe,

 Manfred Ssykor für die wirklich ausgefallenen Ideen und die Zusam-
     menarbeit bezüglich der Atari Infopages,

 Holger Weets für seinen ST-Guide, die prompte Beantwortung vieler
     Fragen bezüglich der ST-Guide-Syntax und das Ignorieren meiner
     verrückten Ideen,

 Michael Wurm für die ST-Guide-FAQ, in der er immer fleißig auf UDO
     hinweist (wie wäre es mit einer UDO-FAQ, Michael?),

 Ralf Zimmermann für seine zahlreichen Hinweise bezüglich der HTML-
     Ausgabe und zControl,

 alle, die ich in dieser Aufzählung vielleicht vergessen haben könn-
     te. Nicht böse sein. ;-)


1.10  Über diese Anleitung
==========================

Bereits am Umfang dieser Anleitung können Sie vielleicht erkennen,
daß ich versucht habe, die Möglichkeiten von UDO sehr genau zu
beschreiben.

Zu UDO1 ab es noch gar keine Anleitung, die von UDO2 war gerade
einmal 20 KB groß, die von UDO3 40 KB, die von UDO4 140 KB. Wie groß
diese Anleitung wird, kann ich noch gar nicht abschätzen, allerdings
wird auch sie wieder wesentlich umfangreicher sein als die der
Vorgängerversion.

Eine große Bitte an Sie:

    Falls Sie Teile dieser Anleitung nicht verstehen, Funktionen
    nicht ausführlich genug erklärt wurden, Kommandobeschreibungen
    vergessen oder Kommandos sogar falsch beschrieben wurden, so
    teilen Sie mir dies bitte mit, damit ich diese Anleitung dahin-
    gehend berichtigen kann.

Da UDO mein "Kind" ist und ich es damit auch am besten kenne, ist die
Gefahr groß, daß einer der obigen Fälle eingetreten ist. Also melden
Sie bitte Unstimmigkeiten und stellen Sie die Fragen, die diese
Anleitung nicht beantworten kann.



Kapitel 2

Rechtliche Informationen
************************


2.1  Copyright
==============

Das Copyright an UDO und dieser Dokumentation liegen bei Dirk
Hagedorn Software, Sundern.

UDO ist Shareware und darf in der unregistrierten Version auf belie-
bige nichtkommerzielle Weise an Dritte weitergegeben werden, wenn
alle folgenden Voraussetzungen erfüllt werden:

   ∙ Das Programm darf nur mit allen zugehörigen Dateien und in
     unveränderter Form weitergegeben werden.

   ∙ Das Programm darf generell nur kostenlos weitergegeben werden.
     Der Upload in gebührenfreie Mailboxen und auf nichtkommerzielle
     FTP-Server ist erlaubt und erwünscht.

   ∙ Dem Archiv dürfen keine weiteren Dateien hinzugefügt werden,
     insbesondere keine Mailboxwerbung und keine Werbung für PD-
     Serien. Die Umbenennung oder das Umpacken des Archivs ist zu
     unterlassen.

   ∙ Für die Weitergabe auf Disketten im Rahmen einer Public-Domain-
     Serie dürfen keine Gebühren verlangt werden, die einen Betrag
     von 10 DM (exklusive Versandkosten) überschreiten.

   ∙ Die Weitergabe per CD-ROM bedarf meiner schriftlichen
     Genehmigung!


2.2  Haftungsausschluß
======================

Trotz sorgfältiger Entwicklung und umfangreichen Tests kann keine
Gewährleistung für die einwandfreie Funktion von "UDO" und die Rich-
tigkeit des Inhalts dieser Dokumentation übernommen werden.

Der Autor kann keine Haftung für irgendwelche direkten oder indi-
rekten Schäden - einschließlich aber nicht beschränkt auf materielle
oder finanzielle - übernehmen, die durch die Benutzung von "UDO" oder
dessen Untauglichkeit für einen bestimmten Zweck entstehen.


2.3  Warenzeichen
=================

Innerhalb dieser Dokumentation wird auf Warenzeichen Bezug genommen,
die nicht explizit als solche ausgewiesen sind. Aus dem Fehlen einer
Kennzeichnung kann nicht geschlossen werden, daß ein Name frei von
den Rechten Dritter ist.



Kapitel 3

Installation
************


3.1  Installation der Amgia-Version
===================================

Beim Schreiben dieser Anleitung existierte noch keine Version für den
Commodore Amiga. Beachten Sie daher die Anweisungen, die in der
Distribution für den Amiga beigelegt werden.


3.2  Installation der TOS- und GEM-Version
==========================================

Zur Installation von UDO auf einem Atari-(Kompatiblen-)Rechner ko-
pieren Sie einfach alle Dateien in ein Verzeichnis, welches sinni-
gerweise "UDO" genannt werden sollte.

Falls Sie das TTP bevorzugen und mit einem Kommandozeileninterpreter
(z.B. mit der Mupfel von Stefan Eissing) arbeiten, so kopieren oder
verschieben Sie udo.ttp in eines der in $PATH angegebenen
Verzeichnisse.

Falls Sie den ST-Guide installiert haben, so sollten Sie udo.hyp und
udo.ref in Ihr Verzeichnis kopieren oder verschieben, in dem Sie auch
alle anderen Hypertexte aufbewahren. Nur dann können auch andere Hy-
pertexte auf den UDO-Hypertext zugreifen!


3.3  Installation der DOS-Version
=================================

Das Wichtigste zuerst: Da UDO mit dem EMX-GCC compiliert wurde, wird
zum Betrieb der DOS-Version unbedingt das EMX-Runtime-Paket
(emxrt.zip) von Eberhard Mattes benötigt! Will man UDO in einer DOS-
Box unter Windows 3.1 laufen lassen, benötigt man das Archiv
dpmigcc5.zip von Rainer Schnitker

Sollten Sie die obigen Archive nicht zusammen mit UDO erhalten haben,
so können Sie sie auf folgenden Wegen erhalten:

  1. per FTP:

        ∙ ftp.uni-stuttgart.de/pub/systems/os2/emx-0.9b/emxrt.zip

        ∙ ftp.uni-bielefeld.de/pub/systems/msdos/misc/dpmigcc5.zip

  2. per WWW-FTP: aktuelle Links finden Sie auf meiner Homepage. Die
     URL lautet http://members.aol.com/DirkHage/www/index.htm.

  3. per Modem aus dem Gruppenprogrammteil UDO.Pub oder dem Öffent-
     lichen Programmteil der Maus MK2 (02371-944925)

  4. per Einsendung einer formatierten Diskette samt eines rück-
     adressierten und mit 2 DM frankierten Umschlags (siehe
     Bezugsquellen).

Die Installation von UDO beschränkt sich auf das Anlegen eines Ord-
ners, den man "UDO" nennen sollte.

Um nun UDO direkt aus COMMAND.COM starten zu können, empfiehlt es
sich, in einem der in PATH angegebenen Verzeichnisse eine Batch-Datei
anzulegen, die UDO passend aufruft. Im folgenden Beispiel gehe ich
davon aus, daß UDO auf Laufwerk D: im Verzeichnis \udo installiert
wurde:

    [udo.bat]
    @d:\udo\udo386.exe %1 %2 %3 %4 %5 %6 %7 %8 %9

Desweiteren ist es sehr hilfreich, wenn man sich passende Batch-Files
zur Übersetzung in bestimmte Formate anlegt, um UDO ohne große Tipp-
arbeit aufrufen zu können. Beispiel:

    [u2win.bat]
    @d:\udo\udo386.exe --win -o ~ %1 %2 %3 %4 %5 %6 %7 %8 %9

    [u2html.bat]
    @d:\udo\udo386.exe --html -o ~ %1 %2 %3 %4 %5 %6 %7 %8 %9

Tip: Wer den Norton Commander benutzt, kann dann diese Batch-Files
als Anwendung für Dateien mit der Endung .u anmelden und nach dem
Anklicken einer solchen Datei auswählen, in welches Format die UDO-
Datei umgewandelt werden soll.

Zur Installation des EMX-Runtime-Package und des DPMI-Treibers lesen
Sie sich bitte die zugehörigen Installationanleitungen aufmerksam
durch.


3.4  Installation der HP-UX-Version
===================================

Nach Entpacken des Archivs kopieren Sie das Binary in das Verzeichnis
/opt/bin oder /opt/hppd/bin bzw. in eines der Verzeichnisse Ihres
$PATH's.

Desweiteren empfiehlt sich das Anlegen von Shellscripts. Dieses
Beispiel, dem der Name u2tex gegeben werden sollte, erleichert die
Umwandlung eines Quelltextes in das LaTeX-Format.

    if [ $# -eq 0 ]
    then
        echo "usage:" $0 "[ options ] file"
    else
        udo --tex -o ! $*
    fi

Für die anderen Formate können ähnliche Scripts angelegt werden. In
der Distribution sollten Sie diese Script bereits vorfinden.


3.5  Installation der Linux-Version
===================================

Nach Entpacken des Archivs kopieren Sie das Binary in das Verzeichnis
/usr/local/bin oder in eines der Verzeichnisse Ihres $PATH's.

Desweiteren empfiehlt sich das Anlegen von Shellscripts. Dieses
Beispiel, dem der Name u2tex gegeben werden sollte, erleichert die
Umwandlung eines Quelltextes in das LaTeX-Format.

    if [ $# -eq 0 ]
    then
        echo "usage:" $0 "[ options ] file"
    else
        udo --tex -o ! $*
    fi

Für die anderen Formate können ähnliche Scripts angelegt werden. In
der Distribution sollten Sie diese Script bereits vorfinden.


3.6  Installation der Macintosh-Version
=======================================

Beim Schreiben dieser Anleitung existierte noch keine native Version
für den Apple Macintosh. Beachten Sie daher die Anweisungen, die in
der Distribution für den Macintosh beigelegt werden.



Kapitel 4

Bedienung
*********

In diesem Kapitel werden Sie erfahren, welche Parameter Sie der Kom-
mandozeilenversion übergeben müssen bzw. wie Sie die Version(en) mit
grafischer Oberfläche nutzen können.


4.1  Kommandozeilenversion
==========================

Die Kommandozeilenversionen für die verschiedenen Betriebssysteme
lassen sich alle identisch bedienen (was kein Wunder ist, da alle mit
demselben Sourcecode compiliert wurden).

Bei der Übergabe der Optionen beachten Sie bitte folgendes:

  1. Optionen sind einzeln zu übergeben.
     Die Übergabe von -a -l -y ist nicht identisch mit der Übergabe
     von -aly.

  2. Die Quelldatei muß der letzte Parameter sein.
     Übergeben Sie UDO zunächst die Optionen und zum Schluß den Namen
     der umzuwandelnden Quelldatei.


4.1.1  Kommandozeilen-Optionen
------------------------------

 -a, --ascii        Die Quelldatei wird ins ASCII-Format umgewandelt.

 -c, --nocheck      Bei der Umwandlung wird die richtige Verwendung
                    von Textstilen nicht überprüft.

 -h, --html         Die Quelldatei wird ins HTML-Format umgewandelt.

 -H, --hold         UDO wartet am Programmende auf einen Tastendruck

 --help             Ausgabe einer Hilfsseite, die diese Optionen
                    erklärt.

 -i, --texinfo      Die Quelldatei wird ins GNU-Texinfo-Format
                    umgewandelt.

 --ident            Bei Angabe dieser Option gibt UDO das Datum eines
                    jeden wichtigen C-(Header-)Files aus.

 -l, --nologfile    UDO legt (bei gleichzeitiger Verwendung von -o)
                    keine Protokolldatei an.

 -m, --man          Die Quelldatei wird ins Manualpage-Format
                    umgewandelt.

 -o F, --outfile F  UDO schreibt seine Ausgaben in die Datei namens
                    "F". Wird anstatt eines Dateinamens ein "!"
                    angegeben, so wird die Ausgabedatei im gleichen
                    Verzeichnis und mit dem gleichen Namen, jedoch
                    mit ausgabeformatabhängiger Dateiendung,
                    angelegt.

 -p, --pchelp       Die Quelldatei wird ins Pure-C-Help-Quelltext-
                    format umgewandelt.

 -q, --quiet        Die Ausgabe von Statusmeldungen wird komplett
                    unterdrückt.

 -r, --rtf          Die Quelldatei wird ins Rich Text Format
                    umgewandelt.

 -s, --stg          Die Quelldatei wird ins ST-Guide-Quelltextformat
                    umgewandelt.

 -t, --tex          Die Quelldatei wird ins LaTeX-Format umgewandelt.

 --test             Bei zusätzlicher Angabe dieser Option, wird keine
                    Ausgabedatei erzeugt, sondern nur ein Logfile
                    und ggf. die Datei mit den Rohlingen für die
                    Trennvorschläge. Diese Option ist nützlich, falls
                    man die sytaktische Korrektheit des Quelltextes
                    überprüfen möchte.

 --tree             Wird diese Option benutzt, so legt UDO in einer
                    Datei mit der Endung .ut? eine baumartige Über-
                    sicht der benutzten Dateien an. Bei intensiver
                    Benutzung des Befehl !include sieht man dann,
                    welche Datei andere Dateien nachladen.

 -v, --vision       Die Quelldatei wird ins Turbo-Vision-Help-Format
                    umgewandelt.

 --verbose          Bei der Konvertierung werden zusätzlich Infor-
                    mationen über die gerade bearbeitete Datei
                    und das gerade bearbeitete Kapitel ausgegeben.

 --version          Gibt die Versionsnummer und das Erstellungsdatum
                    von der Kommandozeilenversion aus.

 -w, --win          Die Quelldatei wird ins WinHelp-Quelltextformat
                    umgewandelt.

 -x, --linuxdoc     Die Quelldatei wird ins Linuxdoc-SGML-Format
                    umgewandelt.

 -y, --nohypfile    UDO legt (bei gleichzeitiger Verwendung von -o)
                    keine Datei mit Trennvorschlägen an.


4.1.2  Environment
------------------

Die Kommandozeilenversion wertet folgende Umgebungsvariablen aus:

 LANG         Legt die zu benutzende Landessprache für Fehlermel-
              dungen fest, wenn weder LC_ALL noch LC_MESSAGES
              existiert.

 LC_ALL       Wenn diese Environmentvariable auf `german' gesetzt
              ist, benutzt UDO deutschsprachige Meldungen. Für andere
              Werte werden englischsprachige Meldungen benutzt.
              Existiert diese Variable nicht, wird stattdessen
              LC_MESSAGES überprüft.

 LC_MESSAGES  Siehe LC_ALL. Wenn auch diese Variable nicht existiert,
              wird stattdessen LANG benutzt.


4.1.3  Rückgabewerte der Kommandozeilenversion
----------------------------------------------

Die Kommandozeilenversion gibt nach Beendigung folgende Werte zurück:

 0:     Die Umwandlung wurde ohne Probleme durchgeführt.

 sonst: Bei der Umwandlung ist ein Fehler aufgetreten. Diese können
        syntaktischer Art sein oder ihren Grund im Nichtauffinden von
        Quelltexten oder Bilder haben.


4.2  GEM-Version
================


4.2.1  Die GEM-Version kurz vorgestellt
---------------------------------------

Die GEM-Version ist mehr als eine Kommandozeilenversion in grafischem
Gewand. Sie bietet über die Möglichkeit, UDO-Quelltexte umzuwandeln,
Funktionen zum Aufruf eines Editors, eines Dateibetrachters (Viewers)
und von Programmen, die die von UDO ausgegebenen Dateien
weiterbearbeiten.

In den folgenden Abschnitten werden Ihnen lediglich die wichtigsten
Punkte dieser GEM-Version beschrieben. Wie man mit GEM-Programmen
umgeht, sollten Sie bereits wissen. Falls dies nicht der Fall sein
sollte, so werfen Sie bitte zunächst einen Blick in das Handbuch zu
Ihrem Rechner.

Die GEM-Version läuft auf allen Rechner mit GEM-kompatiblem Be-
triebssystem, also Atari ST/TT/Falcon, Eagle, Medusa, Apple Macintosh
mit MagiCMac, GEMulator, Janus. Die Auflösung sollte mindestens 640
Punkte in der Horizontalen betragen; die Anzahl der benutzten Farben
spielt keine Rolle.

Die GEM-Version bietet (abschaltbaren) 3D-Look beim Einsatz von 16
Farben oder mehr, Unterstützung von Drag & Drop und des VA-Proto-
kolls, Unterstützung von MultiTOS/MagiC- und ICFS-Iconifying. Alert-
boxen, Dialogboxen und Menüzeilen werden in Fenstern dargestellt,
wodurch parallel laufende Programme ebensowenig ausgebremst werden
wie beim eigentlichen Umwandlungsvorgang, der sich in der GEM-Version
durch gleichzeitiges Drücken der beiden Shift-Tasten unterbrechen
läßt.


4.2.2  GEM-Hauptdialog
----------------------

Der Hauptdialog ist aufgeteilt in eine Menüzeile, in Felder für
Quell- und Zieldatei, einer Box, in dem man das gewünschte Zielformat
einstellen kann, einer Zeile mit Statusinformationen sowie ein je
einen Button zum Starten der Konvertierung, zum Ein- und Ausschalten
des Testmodus und zum Anzeigen des ST-Guide-Hypertextes zu UDO.


Der Dialoginhalt

 Quelle:
     Klicken Sie auf den nebenstehenden Button. Es öffnet sich der
     Fileselector, in dem Sie eine Quelldatei auswählen können.

 Ziel:
     Klicken Sie auf den nebenstehenden Button. Es öffnet sich der
     Fileselector, in dem Sie eine Quelldatei auswählen können.

 Zielformat:
     Wählen Sie hier das gewünschte Zielformat.

 Status:
     Hier sehen Sie während der Umwandlung Informationen über die
     Datei, die gerade bearbeitet wird.

 Konvertieren:
     Klicken Sie auf diesen Button, um die Umwandlung zu starten.
     Wird der Button hell dargestellt, beachten Sie die Informationen
     in der Statuszeile.

 Testmodus:
     Ist dieser Button selektiert, so entspricht dies der Übergabe
     der Option -test der Kommandozeilenversion.

 Hilfe:
     Der ST-Guide wird beauftragt, den Hypertext von UDO anzuzeigen.


4.2.3  Die Menüzeile des GEM-Hauptdialogs
-----------------------------------------

 UDO/Über UDO:
     Öffnet eine Dialogbox mit Informationen zu UDO

 UDO/Beenden:
     UDO soll beendet werden.

 Quelle/Wählen:
     Der Fileselector wird geöffnet zwecks Auswahl der Quelldatei.

 Quelle/Editieren:
     Startet den Quelleditor gemäß den Einstellungen im GEM-Dialog
     `Externe Programme'.

 Quelle/Anzeigen:
     Startet den Quellviewer gemäß den Einstellungen im GEM-Dialog
     `Externe Programme'.

 Quelle/Konvertieren:
     Startet die Umwandlung der Quelldatei.

 Ziel/Wählen:
     Der Fileselector wird geöffnet zwecks Auswahl der Zieldatei.

 Ziel/Editieren:
     Startet den Zieleditor gemäß den Einstellungen im GEM-Dialog
     `Externe Programme'.

 Ziel/Anzeigen:
     Startet den Zielviewer gemäß den Einstellungen im GEM-Dialog
     `Externe Programme'.

 Ziel/Programm starten:
     Startet das für das aktuell gewählte Zielformat zugehörige
     Programm.

 Ziel/ST-Guide:
     Ist als Ausgabeformat "ST-Guide" selektiert, so wird dem ST-
     Guide aufgetragen, den Hypertext namens `<zieldatei>.hyp'
     anzuzeigen.

 Optionen/Einstellungen:
     Öffnet den GEM-Dialog `Einstellungen'.

 Optionen/Externe Programme:
     Öffnet den GEM-Dialog `Externe Programme'.

 Optionen/3D-Look:
     Ist dieser Menüeintrag selektiert, so werden Dialog- und Alert-
     boxen im 3D-Look dargestellt, falls 16 oder mehr Farben zur
     Verfügung stehen.

 Optionen/Registrieren:
     Öffnet den GEM-Dialog `Registrierung'.

 Optionen/Parameter sichern:
     Die Einstellungen werden in der Datei `udo.inf' in
     $HOME\defaults bzw. $HOME gesichert.

 Optionen/Parameter laden:
     Die Datei `udo.inf' wird geladen und die darin gesicherten
     Einstellungen übernommen.

 Hilfe/Hilfe:
     Der ST-Guide zeigt den Hilfstext zum GEM-Hauptdialog an.

 Hilfe/Inhalt:
     Der ST-Guide zeigt das Inhaltsverzeichnis des UDO-Hypertextes
     an.

 Hilfe/Index:
     Der ST-Guide zeigt den Index des UDO-Hypertextes an.

 Hilfe/Befehlsindex:
     Der ST-Guide zeigt den Befehlsindex an.


4.2.4  GEM-Dialog `Einstellungen'
---------------------------------

 Zieldatei anpassen:
     Ist dieser Button selektiert, so wird bei einem Wechsel des Aus-
     gabeformates im Hauptdialog der Name der Zeildatei angepaßt.

     Ist "Komplett" selektiert, so werden Laufwerk, Pfad, Dateiname
     und -endung angepaßt.

     Ist "Name und Endung" selektiert, so werden Dateiname und -en-
     dung angepaßt. Laufwerk und Zugriffspfad werden nicht geändert.

     Ist "Nur Endung" selektiert, so wird lediglich die Dateiendung
     der Zieldatei an das jeweilige Ausgabeformat angepaßt.

 Zieldatei anzeigen:
     Ist dieser Button selektiert, so wird die Zieldatei nach dem Um-
     wandlungsvorgang automatisch an den Zielviewer übergeben.

 Nachfrage vor Programmende:
     Wenn dieser Button selektiert ist, so erfolgt vor der Beendigung
     von UDO eine Sicherheitsabfrage.

 Nachfrage vor Überschreiben:
     Falls die Zieldatei bereits existiert, so fragt UDO vor der
     Umwandlung nach, ob die bereits existierende Datei überschrieben
     werden soll. Ist der Button nicht selektiert, so erfolgt keine
     Sicherheitsabfrage.

 Logfile anlegen:
     Wenn dieser Button selektiert ist, so schreibt UDO Fehlermel-
     dungen und Informationen in eine Datei mit der Endung .ul?.
     Keine Selektion dieses Buttons entspricht der Komandozeilen-
     Option --nologfile.

 Hyphenfile anlegen:
     Ist dieser Button selektiert, so legt UDO vor der Umwandlung
     eine Datei mit der Endung .uh? an, in die alle Worte mit voran-
     gestelltem !hypen-Kommando, die nicht getrennt werden konnten
     und dadurch einen groben Flatterrand hinterlassen. Ist der
     Button deselektiert, entspricht dies der Übergabe der Komman-
     dozeilen-Option --nohypfile.

 Treefile anlegen:
     Die Selektion dieses Buttons entspricht der Übergabe der Kom-
     mandozeilen-Option --tree und bewirkt die Ausgabe einer baumar-
     tigen Übersicht. In ihr kann man sehen, welcher Teil des Quell-
     textes welchen Teil nachlädt.

 Statusmeldungen:
     UDO zeigt im Hauptdialog während der Umwandlung Statusmeldungen
     an, falls dieser Button selektiert ist. Ist er es nicht, so wird
     lediglich "Konvertierung läuft..." oder ähnliches ausgegeben.


4.2.5  GEM-Dialog `Externe Programme'
-------------------------------------

Diese Dialogbox sieht zunächst verwirrender aus, als sie wirklich
ist. ;-)

Im oberen Bereich wählen Sie das Programm aus, welches Sie konfigu-
rieren möchten. Den Quellviewer, -editor, Zielviewer und -editor
können Sie über das Menü des Hauptdialoges aufrufen. Die spezifischen
Programme können Sie im Zielmenü des Hauptdialoges über den Menüpunkt
"Programm starten" aufrufen.

Nachdem Sie das zu konfigurierende Programm selektiert haben,
können Sie durch einen Klick auf den Button neben "Programm:" die
zugehörige Programmdatei bestimmen. Klicken Sie VA_START an, falls
dieses Programm das VA-Protokoll unterstützt. Falls das Programm ein
TOS-Programm ist, also keine Fenster oder Menüzeilen verwendet, so
selektieren Sie den zugehörigen Button an.

Im unteren Eingabefeld schließlich können Sie die Parameter angeben,
die einem Programm übermittelt werden sollen. Falls Sie die Quell-
oder Zieldatei oder Logfiles übergeben wollen, so können Sie hierfür
Platzhalter verwenden. Welche dies genau sind, erfahren Sie, wenn
Sie den Button "Hinweis..." anklicken.

Wenn Sie nun im Hauptdialog "Programm starten..." aufrufen, wird das
zugehörige Programm gestartet. Somit kann man z.B. den HCP des ST-
Guide damit beauftragen, den gerade frisch umgewandelten Hypertext zu
kompilieren oder eine Textverarbeitung zu starten, um das RTF-File
auszudrucken.




Und so startet UDO externe Programme
------------------------------------

Beim Starten von Programmen geht die GEM-Version folgendermaßen vor:

  1. Wenn Gemini als Desktop benutzt wird, wird Gemini beauftragt,
     das Programm zu starten (da fällt mir gerade auf, daß ein AV-
     Server gar nicht unterstützt wird, was ich so schnell als mög-
     lich nachliefern werde).

  2. Wenn das Programm ein Accessory ist (dies erkennt UDO anhand der
     Endung .acc), so werden die Parameter per VA_START an das
     Accessory übergeben, falls dieses installiert ist.

  3. Wenn MagiC als Betriebssystem benutzt wird, wird das Programm
     parallel gestartet.

  4. Wenn MultiTOS installiert ist, wird das zugehörige Programm
     ebenfalls parallel gestartet.

  5. Läuft kein Multitasking-Betriebssystem, so wird das Programm
     mittels pexec() gestartet. Zuvor schließt UDO seine Fenster.



Kapitel 5

Die UDO-Syntax
**************


5.1  Quelltext-Beispiel
=======================

Bevor ich ins Detail gehen werde, möchte ich Ihnen an dieser Stelle
ein Beispiel eines kompletten Quelltextes zeigen, welches Ihnen auch
dazu dienen kann, eigene Quelltexte mit UDO zu erstellen:

    ------------------------------------------------------------------

    ########################################
    # @(#) UDO-Beispiel-Quelltext
    # @(#) Dirk Hagedorn, 08.04.1996
    ########################################

    !tex \documentstyle[11pt,german]{article}
    !stg @subject "Dokumentation/Utilities"

    !title   Ein
    !program UDO-Beispiel-Quelltext
    !date    (!today)
    !author  Dirk Hagedorn

    !use_auto_subtocs    [info,html,stg,tvh,win]
    !use_auto_subsubtocs [info,html,stg,tvh,win]
    !no_effects          [asc]

    ########################################

    !begin_document
    !maketitle
    !tableofcontents

    !node Automatische Formatierung

    UDO sorgt selber für die Formatierung
    des Quelltextes. Es nützt nichts, zwischen
    zwei                          Worte
    mehrere Leerzeichen einzufügen, da UDO selber für die
    richtigen Wortabstände und den Zeilenumbruch sorgt.


    Auch nützt es nichts, zwischen zwei Absätze mehrere
    Leerzeilen einzufügen. Auch hier greift UDO ein und trennt
    Absätze durch die ihm richtig erscheinende Anzahl von
    Leerzeilen.

    Absätze trennt man durch Leerzeilen oder UDO-Befehle.


    !node Ein Kapitel
    Dies ist der Text des Kapitels.

    Bei Hypertexten erfolgt aufgrund der im Vorspann gesetzten
    Schalter hier eine Auflistung aller diesem Kapitel
    zugehörigen Abschnitte und Unterabschnitte.

    !subnode Ein Abschnitt.
    Dies ist der Text des Abschnitts. Auch hier folgt ein
    Unterinhaltsverzeichnis.

    !subsubnode Ein Unterabschnitt.
    Dies ist der Text des Unterabschnitts.

    !end_document
    ------------------------------------------------------------------


Erläuterungen
-------------

Zu Beginn des Quelltextes ist ein Kommentar angegeben, damit man
später noch auf Anhieb erkennen kann, womit sich der Text befaßt.
Eine Zeile bewertet UDO als Kommantar, wenn das erste Zeichen der
Zeile ein `#' ist.

Es folgt eine Zeile, die nur für LaTeX ausgegeben wird. Hier set-
zen wir die für LaTeX unentbehrlichen Informationen, wie der Text
zu formatieren ist. Sollten Sie sich nicht mit LaTeX auskennen, so
benutzen Sie diese Zeile zu Beginn Ihrer Quelltexte.

Danach wird wiederum eine spezielle Zeile angegeben. In diesem Falle
wird dem ST-Guide mitgeteilt, in welche Rubrik der Hypertext in den
Katalog einzuordnen ist. Kennen Sie sich nicht mit dem ST-Guide aus,
so verwenden Sie einfach diese Zeile zu Beginn Ihres Quelltextes.

Nun werden die Informationen für die Titelseite und die Kopfzeilen
gesetzt, die bei einigen Formaten automatische erzeugt werden. !title
und !program bilden eine Einheit, daher sollte beides zusammenge-
nommen einen Sinn ergeben. Hier würde bei einigen Formaten in den
Kopfzeilen "Ein UDO-Bespiel-Quelltext" ausgegeben. Bei !date wird
der Platzhalter (!today) durch das aktuelle Systemdatum expandiert.
Sie können natürlich auch manuell für die Angabe des Datums sorgen
(z.B. !date 8. April 1996.

Im Vorspann werden nun noch einige Schalter gesetzt. Die ersten
beiden Schalter sorgen bei Hypertexten, deren Kürzel Sie in den
eckigen Klammern erkennen, für die Ausgabe sogenannter `Unterin-
haltsverzeichnisse'. In diesen werden dann alle Abschnitte und Un-
terabschnitte eines Kapitels bzw. alle Unterabschnitte eines Ab-
schnittes in Form eines Inhaltsverzeichnisses aufgelistet. Dem Leser
eines Hypertextes wird es dadurch ermöglicht, direkt zu den zugehö-
ri!_gen Abschnitten weiterzuklicken. Theoretische wäre es auch
möglich, bei jedem Kapitel durch die Angabe des Befehls !subtoc bzw.
bei jedem Abschnitt durch die Angabe des Befehls !subsubtoc diese Un-
terinhaltsverzeichnisse einzufügen. Bei kleineren Texten empfiehlt es
sich jedoch, diese Ausgabe zu automatisieren.

Der Schalter !no_effects [asc] schließlich sorgt für die Unter-
drückung der Schriftarten für das ASCII-Format. Würde dieser Schal-
ter nicht angegeben, so würde UDO beim ASCII-Format die in der DFÜ
gebräuchlichen Zeichen zur Schriftartumschaltung benutzen.

Das Kommando !begin_document teilt UDO mit, daß nun der Hauptteil des
Quelltextes beginnt. Dieses Kommando darf in keinem Quelltext feh-
len, da hier unverzichtbare Informationen für die Ausgabe-
formate ausgegeben werden!

Zu Anfang geben wir eine Titelseite aus, die aus den Informationen
aus der im oberen Teil des Vorspanns gebildet wird. Das Kommando
!maketitle sollte - wenn es benutzt wird - direkt hinter
!begin_document angegeben werden. UDO erlaubt zwar auch den Einsatz
an späterer Stelle, jedoch ist dies weder sinnvoll noch
unproblematisch.

Danach möchten wir, daß UDO ein Inhaltsverzeichnis ausgibt. In diesem
sind alle Kapitel, Abschnitte und Unterabschnitte des Quelltextes
aufgelistet. Das oben Gesagte gilt auch hier. Wird der Befehl
!tableofcontents benutzt, so sollte er direkt hinter !maketitle oder
(bei Verzicht auf die Ausgabe der Titelseite) hinter !begin_document
angegeben werden.

Endlich! Nach dem ganzen Vorgeplenkel beginnen wir mit dem Befehl
!node das erste Kapitel. Beachten Sie bitte auch den Inhalt dieses
Kapitels, da er weitere Informationen enthält.

Die folgenden Zeilen demonstrieren, wie man Kapitel, Abschnitte und
Unterabschnitte erzeugt. Auch hier sollten Sie einen Blick auf den
Text werfen.

Unser Quelltext ist nun beendet. Dies zeigen wir UDO mit dem Befehl
!end_document an. Auch dieser Befehl darf in keinem Quelltext fehlen!


5.2  Grundlagen
===============


5.2.1  Let's talk about text, Baby!
-----------------------------------

UDO erwartet als Quelldatei eine Textdatei, wie sie mit jedem ASCII-
Editor erstellt werden kann. Außer ASCII 9 (Tabulator), ASCII 10
(Linefeed) und ASCII 13 (Carriage Return) sollten keine Steuerzei-
chen (d.h. keine Zeichen mit einem ASCII-Wert kleiner als 32) benutzt
werden! Eine Zeile darf nicht länger als 512 Zeichen sein.

UDO kümmert sich bei der Umwandlung selbständig um die Formatierung
des Textes, sprich um den Zeilenumbruch und die Absatzabstände:

 Wörter sind Zeichenfolgen, die durch ein oder mehrere Leerzeichen
     oder Tabulatoren voneinander getrennt sind. UDO gibt Wörter
     durch ein Leerzeichen voneinander getrennt aus.

 Absätze sind Folgen von Wörter, die durch eine oder mehrere Leer-
     zeilen voneinander getrennt in der Quelldatei auftreten. UDO
     sorgt selbständig für den Zeilenumbruch innerhalb von Absätzen
     und gibt automatisch die passende Anzahl von Leerzeilen
     zwischen zwei Absätzen aus.

Auch ist es möglich, Quelltexte mit verschiedenen Zeichensätzen zu
erstellen. Zum einen unterstützt UDO den jeweiligen ASCII-Zeichensatz
des jeweiligen Betriebssystems, auf dem UDO eingesetzt wird, zum
anderen können Sie Passagen einbinden, die im Windows-Zeichensatz
erstellt wurden. Um zwischen den einzelnen Zeichensätzen umzuschal-
ten, verwenden Sie die Befehle !code_ascii und !code_ansi.


5.2.2  Kommandos, Schalter und Platzhalter
------------------------------------------

 Kommandos:   Ein UDO-Kommando ist eine mit einem "!" beginnende
              Zeilenfolge, die am Anfang einer Zeile, eventuell
              eingerückt durch Leerzeichen oder Tabs, steht. Ein
              Kommando bewirkt eine Aktion, wie z.B. die Ausgabe
              eines Inhaltsverzeichnisses (siehe !tableofcontents).

 Schalter:    Ein UDO-Schalter ist eine mit einem "!" beginnende Zei-
              chenfolge, die die Aktionen von UDO oder einem Kommando
              beeinflussen. So gibt es z.B. einen Schalter, der
              bewirkt, daß Bezeichnungen in englischer
              Sprache ("Appendix" statt "Anhang") ausgegeben werden
              (siehe !english).

              Ein Schalter wird nur erkannt, wenn er am Anfang einer
              Zeile, eventuell eingerückt durch Leerzeichen oder Tabs
              eingerückt, steht.

 Platzhalter: Ein Platzhalter ist eine mit "!" beginnende Zeichen-
              folge, die durch runde Klammern eingefaßt ist. Ein
              Platzhalter wird von UDO durch eine dem Ausgabeformat
              zugehörige Zeichenfolge ersetzt (z.B. `(!B)' durch
              `{\bf').

              Platzhalter können an jeder beliebigen Stelle einer
              Zeile stehen.


5.2.3  Kommentare
-----------------

Es besteht die Möglichkeit, in einer Quelldatei Kommentare einzufü-
gen. Ist das erste Zeichen einer Zeile ein "#", so faßt UDO diese
Zeile als Kommentar auf und wertet diese Zeile nicht aus. Das "#"
darf nicht eingerückt sein!

Keine Regel ohne Ausnahme: Innerhalb einer verbatim- oder raw-Umgebug
werden alle Zeilen ausgegeben, also auch die Zeilen, die mit einem
"#" beginnen. Innerhalb dieser Umgebung können also keine Kommentare
benutzt werden.


5.2.4  Vorspann und Hauptteil
-----------------------------

Eine Quelldatei besteht immer aus einem Vorspann (auch "Preambel")
und einem Hauptteil.

Im Vorspann werden grundsätzliche Informationen über den umzuwan-
delnden Text selbst deklariert. Desweiteren können im Vorspann spe-
zielle Kommandos plaziert werden, die UDO mitteilen, wie er die
Quelldatei umwandeln soll (z.B. ob ein kurzes oder ausführliches In-
haltsverzeichnis ausgegeben werden soll, ob Begriffe und Datumsan-
gaben in deutscher oder englischer Sprache erfolgen sollen etc.). Zum
Vorspann zählen alle Zeilen, die vor dem Kommando !begin_document
stehen.

Im Hauptteil schließlich befindet sich der nach Kapiteln, Abschnitten
und Unterabschnitten strukturierte Inhalt des umzuwandelnden
Textes. Der Hauptteil schließt mit dem Kommando !end_document.


5.2.5  Umgebungen
-----------------

Eine Umgebung ist ein Teil der Quelldatei, der speziell behandelt
werden soll. Umgebungen werden jeweils mit !begin_ eingeleitet und
mit !end_ beendet. Diese Befehle müssen dabei jeweils am Anfang einer
Zeile stehen, eventuell eingerückt durch Leerzeichen und/oder
Tabulatoren.

Es gibt zahlreiche Umgebungen, die Ihnen die Arbeit erleichtern
können und die die jeweiligen ausgabeformatspezifischen Be-
sonderheiten berücksichtigen. Hier eine Übersicht:

 appendix-Umgebung:    Anhang
 center-Umgebung:      Zentrierungen
 description-Umgebung: Beschreibungen
 document-Umgebung:    Dokument-Inhalt
 enumerate-Umgebung:   numerierte Aufzählungen
 itemize-Umgebung:     einfache Aufzählungen
 quote-Umgebung:       Einrückungen
 raw-Umgebung:         spezielle Befehle des Ausgabeformats
 verbatim-Umgebung:    vorformatierter Text
 xlist-Umgebung:       Listen

Wie der Text, der innerhalb dieser Umgebungen steht, behandelt wird,
lesen Sie bitte in den zugehörigen Kapiteln nach.


5.3  Gliederung
===============


5.3.1  Titelseite
-----------------

Durch das Kommando !maketitle erzeugt UDO in der Ausgabedatei eine
Titelseite und greift bei der Erzeugung dieser Titelseite auf die
Informationen zurück, die Sie im Vorspann Ihrer Quelldatei mit den
Kommandos !title, !program, !programimage, !version, !date, !author,
!authorimage, !street, !town und/oder !email hinterlegt haben.

!maketitle sollte nur direkt hinter !begin_document eingesetzt wer-
den. UDO erlaubt zwar auch die Erzeugung der Titelseite an späterer
Stelle, allerdings ist dies weder sinnvoll noch unproblematisch.

Die Titelseite wird innerhalb des ST-Guide und WinHelp als eigene
Seite angelegt. Von dieser aus läßt sich dann zum Inhaltsverzeichnis
verzweigen. Dies ist besonders eine große Hilfe für Benutzer mit
kleinen Monitoren, die sonst vor lauter Informationen das Inhalts-
verzeichnis nicht wiederfinden würden.

Bei TeX hingegen wird aus den angegebenen Informationen eine eigene
Titelseite mittels der titlepage-Umgebung erstellt.

Um beim ST-Guide eine eigene Titelseite zu erstellen (sei es, falls
einem die von UDO erzeugte Titelseite nicht gefällt), so muß man
etwas tiefer in die Trickkiste greifen. Dies würde hier allerdings
den Rahmen sprengen. Nähere Informationen zu diesem Thema gibt es
direkt vom Autor.


5.3.2  Inhaltsverzeichnisse
---------------------------

Durch das Kommando !tableofcontents erzeugt UDO in der Ausgabedatei
ein Inhaltsverzeichnis. In das Inhaltsverzeichnis gelangen alle
Überschriften von Kapiteln, Abschnitten und Unterabschnitten.

Der Umfang dieses Inhaltsverzeichnisses läßt sich durch den Schalter
!use_short_toc beeinflussen. Wird dieser Schalter im Vorspann mit dem
jeweiligen Kürzel des betroffenen Ausgabeformats angegeben, so sorgt
UDO dafür, daß ein kurzes Inhaltsverzeichnis ausgegeben wird, in dem
lediglich die Überschriften der Kapitel aufgelistet sind.

Desweiteren gibt es Befehle wie !subtoc, mit denen Sie alle einem
Kapitel zugehörigen Abschnitte in der Form eines kleinen Inhalts-
verzeichnisses angeben können. Sinn und Zweck dieser sogenannten "Un-
terinhaltsverzeichnisse" ist es, dem Leser eines Hypertextforma-
tes (ST-Guide, Pure-C-Help, HTML, WinHelp) das direkte Weiterlesen zu
ermöglichen. Besonders beim Einsatz von !use_short_toc empfiehlt sich
der Gebrauch dieser Inhaltsverzeichnisse.

Anmerkung: Bei der Ausgabe ins Rich Text Format wird kein Inhalts-
verzeichnis ausgegeben! Dieses sollten Sie durch entsprechende Funk-
tionen Ihrer bevorzugten Textverarbeitung, mit der Sie das RTF-File
weiterbearbeiten, erzeugen.


5.3.3  Kapitel, Abschnitte und Unterabschnitte
----------------------------------------------

Durch das Kommando !node setzen Sie den Anfang für ein neues Kapitel
und übergeben zugleich die Kapitelüberschrift. Genauso funktionieren
die Kommandos !subnode für einen Abschnitt und !subsubnode für einen
Unterabschnitt.

Da Bilder oft mehr sagen als tausend Worte, hier eine kleines Bei-
spiel. Die (hier inhaltsleere) Befehlsfolge...

    !node       Ein Kapitel
    !subnode    Ein Abschnitt
    !subsubnode Ein Unterabschnitt
    !node       Ein neues Kapitel

...stellt UDO im Inhaltsverzeichnis folgendermaßen dar:

    1 Ein Kapitel
      1.1 Ein Abschnitt
          1.1.1 Ein Unterabschnitt

    2 Ein neues Kapitel

Desweiteren besteht die Möglichkeit, Kapitel, Abschnitte und Unter-
abschnitte auch als Popups darzustellen, welche von WinHelp und vom
ST-Guide unterstützt werden. Um ein Kapitel nun in diesen beiden For-
maten nicht als eigene Seite, sondern als Popup darzustellen, muß man
!pnode anstatt !node verwenden, dito für Abschnitte (!psubnode) und
Unterabschnitte (!psubsubnode).

Wie Sie sehen, numeriert UDO die Kapitel durch. Falls Sie nun kein
Interesse an diesen Nummern haben sollten, so können Sie den Befehl
!no_numbers benutzen, um die Ausgabe von Kapitelnummern zu
unterdrücken.


5.3.4  Anhang
-------------

UDO kann auch einen(!) Anhang verwalten. Der Anhang steht innerhalb
einer appendix-Umgebung, will meinen der Anhang wird durch das Kom-
mando !begin_appendix begonnen und mit !end_appendix beendet.

Kapitel, die im Anhang stehen, werden mit Großbuchstaben gekenn-
zeichnet; Abschnitte und Unterabschnitte werden auch hier durchnu-
meriert. Auch hier zur Verdeutlichung ein kleines Beispiel:

    !node Ein Kapitel außerhalb des Anhangs
    !begin_appendix
    !node       Ein Kapitel
    !subnode    Ein Abschnitt
    !subsubnode Ein Unterabschnitt
    !end_appendix

Im Inhaltsverzeichnis werden Sie dann folgendes lesen können:

    5 Ein Kapitel außerhalb des Anhangs

    Anhang

    A Ein Kapitel
      A.1 Ein Abschnitt
          A.1.1 Ein Unterabschnitt


5.4  Texthervorhebungen
=======================

In diesem Abschnitt werden Sie erfahren, mit welchen Kommandos und
Platzhaltern Sie Ihren Text formatieren können. UDO ermöglicht die
Zentrierung und Einrückung von Textpassagen, bietet verschiedene
Aufzählungsumgebungen, eine Umgebung für Klartext und sogar einen
automatischen Tabellensatz. Darüber hinaus stehen selbstverständlich
verschiedene Texteffekte sowie die Möglichkeit, Fußnoten direkt im
Text anzugeben, zur Verfügung.


5.4.1  Zentrieren von Zeilen
----------------------------

Zeilen, die innerhalb einer center-Umgebung stehen, werden in der
Ausgabedatei zentriert dargestellt, sofern das jeweilige Ausga-
beformat zentrierten Text unterstützt.

Die center-Umgebung ist mit sich selbst nicht schachtelbar (was ja
auch überhaupt keinen Sinn machen würde), kann jedoch auch innerhalb
anderer Umgebungen benutzt werden. Theoretisch ist aus möglich,
andere Umgebungen innerhalb der center-Umgebung zu benutzen, aller-
dings sieht das Ergebnis zumeist sehr seltsam aus.

Falls das folgende kleine Beispiel nicht zentriert wird, liegt das
daran, daß Format keine Zentrierungen zuläßt. Aus...

    !begin_center
    Eine zentrierte Zeile.

    Ein zentrierter Absatz,
    der vorher formatiert wird.

    Die Anleitung zu (!nl)
    UDO
    !end_center

...wird:

                       Eine zentrierte Zeile.

         Ein zentrierter Absatz, der vorher formatiert wird.

                          Die Anleitung zu
                                 UDO

Wie man sieht, formatiert UDO Absätze auch hier. Um einen manuellen
Zeilenumbruch zu setzen, bedient man sich des Befehls (!nl).


5.4.2  Einrücken von Absätzen
-----------------------------

Um Absätze eingerückt darzustellen, klammert man sie im Quelltext mit
den Befehlen !begin_quote und !end_quote.

Diese Umgebung eignet sich dazu, Textpassagen deutlicher vom restli-
chen Text abzuheben. Dieser Effekt wurde auch bei folgendem Bei-
spiel benutzt:

    !begin_quote
    Dieser Absatz steht innerhalb einer quote-Umgebung
    und wird links eingerückt.
    !end_quote

...wird:

    Dieser Absatz steht innerhalb einer quote-Umgebung und wird links
    eingerückt.

Anmerkung: Bei HTML werden die Einrückungen durch <BLOCKQUOTE> er-
zeugt. Netscape und CAB geben solche Absätze auch eingerückt aus;
Mosaic hingegen rückt diese Absätze nicht ein, sondern ermöglicht
lediglich die Zuweisung eines speziellen Fonts. Als Defaultein-
stellung wird hier ein kursiver Font benutzt.


5.4.3  Einfache Aufzählungen
----------------------------

Mit der itemize-Umgebung lassen sich auf einfache Art und Weise
Aufzählungen erstellen, bei denen die Aufzählungspunkte durch Punkte
und Striche gekennzeichnet werden.

Eine itemize-Umgebung wird mit !begin_itemize eingeleitet und mit
!end_itemize beendet. Die einzelnen Aufzählungspunkte werden jeweils
mit dem Kommando !item gekennzeichnet.

Die Befehle zum Einleiten oder Beenden der Umgebung bzw. zum Einlei-
ten eines Aufzählungspunktes müssen am Zeilenanfang stehen,
eventuell eingerückt durch Leerzeichen oder Tabulatoren.

Die itemize-Umgebung kann bis zu viermal verschachtelt benutzt
werden und läßt sich auch mit anderen Umgebungen kombinieren.

Aus diesem kurzen Beispiel...

    !begin_itemize
    !item Dies ist der erste Aufzählungspunkt.
    !item Dies ist der zweite Aufzählungspunkt, dessen
          Absatz etwas länger ist und bei dem man
          erkennen kann, wie die Aufzählung formatiert
          wird.

          Dies ist der zweite Absatz des zweiten
          Punktes, der passend eingerückt wird.
    !item Dies ist der letzte Aufzählungspunkt.
    !end_itemize

... wird:

   ∙ Dies ist der erste Aufzählungspunkt.

   ∙ Dies ist der zweite Aufzählungspunkt, dessen Absatz etwas länger
     ist und bei dem man erkennen kann, wie die Aufzählung formatiert
     wird.

     Dies ist der zweite Absatz des zweiten Punktes, der passend
     eingerückt wird.

   ∙ Dies ist der letzte Aufzählungspunkt.

Und aus diesem kleinen Beispiel, in dem die itemize-Umgebung ver-
schachtelt benutzt wird,...

    !begin_itemize
    !item Dies ist Punkt 1 der äußeren itemize-Umgebung.
    !item Dies ist Punkt 2 der äußeren itemize-Umgebung.
          !begin_itemize
          !item Dies ist Punkt 1 der inneren Umgebung.
          !item Dies ist Punkt 2 der inneren Umgebung.
          !end_itemize
    !item Dies ist Punkt 3 der äußeren itemize-Umgebung.
    !end_itemize

...erhält man

   ∙ Dies ist Punkt 1 der äußeren itemize-Umgebung.

   ∙ Dies ist Punkt 2 der äußeren itemize-Umgebung.

        - Dies ist Punkt 1 der inneren Umgebung.

        - Dies ist Punkt 2 der inneren Umgebung.

   ∙ Dies ist Punkt 3 der äußeren itemize-Umgebung.


5.4.4  Numerierte Aufzählungen
------------------------------

Die enumerate-Umgebung ist ebenso wie die itemize-Umgebung dafür
geeignet, schnell und komfortabel durchnumerierte Aufzählungen zu
erstellen, bei denen die Aufzählungspunkte durch Zahlen oder Buch-
staben gekennzeichnet werden.

Eine enumerate-Umgebung wird mit !begin_enumerate eingeleitet und mit
!end_enumerate beendet. Die einzelnen Aufzählungspunkte werden je-
weils mit dem Kommando !item gekennzeichnet.

Die enumerate-Umgebung ist ebenfalls bis zu viermal schachtelbar.
Hier ein kleines, unverschachteltes Beispiel: Aus...

    UDO stellt folgende Aufzählungsumgebungen zur Verfügung:
    !begin_enumerate
    !item itemize-Umgebung
    !item enumerate-Umgebung (das ist die Umgebung, die in
          diesem Ab!-schnitt beschrieben wird)
    !item description-Umgebung
    !item xlist-Umgebung
    !end_enumerate

... wird:

UDO stellt folgende Aufzählungsumgebungen zur Verfügung:

  1. itemize-Umgebung

  2. enumerate-Umgebung (das ist die Umgebung, die in diesem Ab-
     schnitt beschrieben wird)

  3. description-Umgebung

  4. xlist-Umgebung

Und aus diesem kleinen Beispiel, in dem die enumerate-Umgebung ver-
schachtelt benutzt wird,...

    !begin_enumerate
    !item Dies ist Punkt 1 der äußeren enumerate-Umgebung.
    !item Dies ist Punkt 2 der äußeren enumerate-Umgebung.
          !begin_enumerate
          !item Dies ist Punkt 1 der inneren Umgebung.
          !item Dies ist Punkt 2 der inneren Umgebung.
          !end_enumerate
    !item Dies ist Punkt 3 der äußeren enumerate-Umgebung.
    !end_enumerate

...erhält man

  1. Dies ist Punkt 1 der äußeren enumerate-Umgebung.

  2. Dies ist Punkt 2 der äußeren enumerate-Umgebung.

      (a) Dies ist Punkt 1 der inneren Umgebung.

      (b) Dies ist Punkt 2 der inneren Umgebung.

  3. Dies ist Punkt 3 der äußeren enumerate-Umgebung.


5.4.5  Beschreibende Aufzählungen
---------------------------------

Die description-Umgebung ist dafür geeignet, eine Beschreibung von
mehreren Begriffen zu erzeugen, wobei Begriffe fett dargestellt
werden.

Ein Aufzählungspunkt wird durch !item [<text>] gekennzeichnet, wobei
"<text>" in der Aufzählung fett dargestellt wird.

Die description-Umgebung ist bis zu viermal schachtelbar. Hier ein
kleines, unverschachteltes Beispiel: Aus...

    UDO stellt folgende Aufzählungsumgebungen zur Verfügung:
    !begin_description
    !item [die itemize-Umgebung]
          für einfache Aufzählungen,
    !item [die enumerate-Umgebung]
          für numerierte Aufzählungen,
    !item [die description-Umgebung]
          für beschreibende Aufzählungen sowie
    !item [die xlist-Umgebung]
          für Listen
    !end_description

... wird:

UDO stellt folgende Aufzählungsumgebungen zur Verfügung:

 die itemize-Umgebung für einfache Aufzählungen,

 die enumerate-Umgebung für numerierte Aufzählungen,

 die description-Umgebung für beschreibende Aufzählungen sowie

 die xlist-Umgebung für Listen

Aus diesem Beispiel, in dem die description-Umgebung verschachtelt
benutzt wird, ...

    !begin_description
    !item [Punkt 1] der äußeren description-Umgebung.
    !item [Punkt 2] der äußeren description-Umgebung.
          !begin_description
          !item [Punkt 1] der inneren Umgebung.
          !item [Punkt 2] der inneren Umgebung.
          !end_description
    !item [Punkt 3] der äußeren description-Umgebung.
    !end_description

...erhält man

 Punkt 1 der äußeren description-Umgebung.

 Punkt 2 der äußeren description-Umgebung.

      Punkt 1 der inneren Umgebung.

      Punkt 2 der inneren Umgebung.

 Punkt 3 der äußeren description-Umgebung.


5.4.6  Listen
-------------

Die xlist-Umgebung eignet sich genau wie die description-Umgebung
zur Erläuterung von Begriffen. Bei dieser Umgebung werden die Be-
schreibungen der Begriffe jedoch alle untereinander aufgeführt. Wie
weit die Beschreibungen eingerückt wird, hängt von der Länge des
bei !begin_xlist [<text>] übergebenen Textes ab. Die beiden eckigen
Klammern werden dabei nicht mitgezählt.

Die Umgebung wird mit !begin_xlist [<text>] eingeleitet und mit
!end_xlist beendet. Ein Aufzählungsbegriff wird wie bei der de-
scription-Umgebung durch !item [<text>] gekennzeichnet.

Aus...

    UDO stellt folgende Aufzählungsumgebungen zur Verfügung:
    !begin_xlist [description-Umgebung:]
    !item [itemize-Umgebung:]
          für einfache Aufzählungen
    !item [enumerate-Umgebung:]
          für numerierte Aufzählungen
    !item [description-Umgebung:]
          für beschreibende Aufzählungen
    !item [xlist-Umgebung:]
          für Listen
          (das ist die Umgebung, die in
          diesem Abschnitt beschrieben wird)
    !end_xlist

... wird:

UDO stellt folgende Aufzählungsumgebungen zur Verfügung:

 itemize-Umgebung:     für einfache Aufzählungen

 enumerate-Umgebung:   für numerierte Aufzählungen

 description-Umgebung: für beschreibende Aufzählungen

 xlist-Umgebung:       für Listen (das ist die Umgebung, die in
                       diesem Abschnitt beschrieben wird)

Achtung: HTML bietet keine direkte Unterstützung für Listen solchen
Typs, daher werden xlist-Umgebungen wie beim ASCII-Format, mit dem
Preformatted-Tag geklammert, ausgegeben.

Durch den Schalter !no_xlist kann man angeben, bei welchen Formaten
die im Quelltext angegebenen xlist-Umgebunden als description-Um-
gebungen behandelt werden sollen.


5.4.7  Vorformatierter Text
---------------------------

UDO sorgt selbständig für die Formatierung des auzugebenden Textes.
Dies ist jedoch nicht immer erwünscht. Will man beispielsweise
Schnippsel eines Sourcecodes darstellen, wäre es fatal, würde UDO
hier eine Formatierung vornehmen.

Zur Ausgabe von vorformatiertem Text kann man sich daher der
verbatim-Umgebung bedienen, welche mit !begin_verbatim begonnen
und mit !end_verbatim beendet wird.

Der Text, der innerhalb dieser Umgebung steht, wird nicht besonders
behandelt, sprich es wird der Zeilenumbruch exakt übernommen und es
werden keine UDO-Kommandos (bis auf !end_verbatim) bearbeitet. Steht
eine verbatim-Umgebung allerdings in einer anderen Umgebung, so
wird der vorformatierte Text zusätzlich eingerückt. Beachten Sie dazu
auch den Hinweis am Ende dieses Abschnitts.

Bei der Ausgabe ins LaTeX-Format werden die gleichnamigen Befehle
\begin{verbatim} und \end{verbatim} ausgegeben, bei den anderen
Formaten wird (falls nötig) ein nichtproportionaler Font einge-
stellt und Sonderzeichen automatisch angepaßt.


Da innerhalb einer verbatim-Umgebung keine UDO-Kommandos und somit
auch nicht !include beachtet werden, wäre es nicht möglich, eine
externe Datei einzuladen und diese unformatiert darzustellen. Aus
diesem Grund bietet UDO den Befehl !vinclude an, der eine Befehls-
kombination aus !begin_verbatim, !include und !end_verbatim
darstellt.

Falls Sie jedoch Passagen benutzen wollen, die bereits im Ausgabe-
format geschrieben wurden (z.B. eine mit LaTeX gesetzte Tabelle), so
muß man sich der raw-Umgebung bedienen.


Hinweise:

  1. Da andere Umgebungen im Quelltext eingerückt werden können,
     erscheint es verlockend, auch eine verbatim-Umgebung im
     Quelltext passend einzurücken. Bedenken Sie allerdings, daß
     führende Leerzeichen bei der Ausgabe des vorformatierten Textes
     übernommen werden und dieser dann in der späteren Ausgabedatei
     zuweit rechts stehen wird, falls Sie den Text der verbatim-Um-
     gebung einrücken.

  2. Tabulatoren innerhalb von vorformatierten Text können zu Pro-
     blemen führen. Achten Sie bitte darauf, daß Sie hier keine
     Tabulatoren benutzen.


5.4.8  Fußnoten
---------------

Text, der durch (!N) und (!n) eingefaßt wird, wird in eine Fußnote
umgewandelt, sofern das Ausgabeformat Fußnoten unterstützt. Bei den
anderen Ausgabeformaten wird (!N) einfach durch " (" und (!n) durch
")" ersetzt; die Fußnote erscheint hier also einfach in Klammern.

Wichtig: Vor (!N) sollte kein Leerzeichen stehen, da sonst die Fuß-
notenmarkierung später in der Ausgabedatei frei im Raum steht und der
Bezug weniger klar erkenntlich wird! Unterstützt das Ausgabeformat
keine Fußnoten, gibt UDO vor der öffnen Klammer zusätzlich noch das
fehlende Leerzeichen aus.

Aus...

    UDO(!N)Universal Document(!n)

wird...

    UDO (Universal Document)

Fußnoten werden von folgenden Formaten unterstützt:

   ∙ LaTeX
   ∙ Texinfo
   ∙ Linuxdoc-SGML
   ∙ RTF


5.4.9  Schriftarten
-------------------

UDO ermöglicht es Ihnen, bereits im Quelltext festzulegen, in welcher
Schriftart Worte oder Sätze im Ausgabeformat erscheinen soll.

UDO unterstützt derzeit fetten, kursiven, unterstrichenen, schat-
tierten, hellen, umrahmten Text, Klartext sowie
Schreibmaschinenschrift.

Um für eine Textpassage eine passende Schriftart zu setzen, müssen
Sie diese mit den zugehörigen Platzhaltern klammern. Lange Rede,
kurzer Sinn, hier der Quelltext, der den oberen Absatz erzeugt hat:

UDO unterstützt derzeit
(!B)fetten(!b),
(!I)kursiven(!i),
(!U)unterstrichenen(!u),
(!S)schattierten(!s),
(!G)hellen(!g),
(!O)umrandeten(!o),
(!F)umrahmten(!f) Text,
(!V)Klartext(!v) sowie
(!T)Schreibmaschinenschrift(!t).

In der folgenden Tabelle können Sie ablesen, durch welche Kommandos
die Schriftarten im jeweiligen Format erzeugt werden:


+------+-------+----------+-------------+--------+---------+--------+
| UDO  | ASCII | ST-Guide | LaTeX       | RTF    | WinHelp | HTML   |
+------+-------+----------+-------------+--------+---------+--------+
| (!B) | *     | @{B}     | {\bf        | {\b    | {\b     | <B>    |
| (!b) | *     | @{b}     | }           | }      | }       | </B>   |
+------+-------+----------+-------------+--------+---------+--------+
| (!I) | /     | @{I}     | {\it        | {\i    | {\i     | <I>    |
| (!i) | /     | @{i}     | }           | }      | }       | </I>   |
+------+-------+----------+-------------+--------+---------+--------+
| (!U) | _     | @{U}     | {\underline | {\ul   | {\ul    | <U>    |
| (!u) | _     | @{u}     | }           | }      | }       | </U>   |
+------+-------+----------+-------------+--------+---------+--------+
| (!S) |       | @{S}     |             | {\shad | {\shad  |        |
| (!s) |       | @{s}     |             | }      | }       |        |
+------+-------+----------+-------------+--------+---------+--------+
| (!G) |       | @{G}     |             |        |         |        |
| (!g) |       | @{G}     |             |        |         |        |
+------+-------+----------+-------------+--------+---------+--------+
| (!O) |       | @{O}     |             | {\outl | {\outl  |        |
| (!o) |       | @{o}     |             | }      | }       |        |
+------+-------+----------+-------------+--------+---------+--------+
| (!F) |       |          | {\fbox      |        |         |        |
| (!f) |       |          | }           |        |         |        |
+------+-------+----------+-------------+--------+---------+--------+
| (!V) |       |          | \verb+      | {\f1   | {\f1    | <PRE>  |
| (!v) |       |          | +           | }      | }       | </PRE> |
+------+-------+----------+-------------+--------+---------+--------+
| (!T) |       |          | {\tt        | {\f1   | {\f1    | <TT>   |
| (!t) |       |          | }           | }      | }       | </TT>  |
+------+-------+----------+-------------+--------+---------+--------+


Wie man sieht, werden bei der Ausgabe ins ASCII-Format die Zeichen
zur Einschaltung von Schriftarten benutzt, wie sie in im Usenet
üblich sind. Die Zeichen werden bei der Ermittlung von Zeilenlängen
nicht berücksichigt.

Wenn man bei einem Ausgabeformat keine Schriftarten benutzen möchte,
so kann man die Ausgabe der Schriftartbefehle durch die Angabe des
Schalter !no_effects unterdrücken. Der Schalter muß dabei zusammen
mit dem/den gewünschten Format(en) im Vorspann angegeben werden. Um
z.B. keine Schriftarten beim ASCII- und Manualpage-Format zu benut-
zen, so benutzt man dafür !no_effects [asc,man].


5.4.10  Tabellen
----------------

Seit Release 5 besteht die Möglichkeit, einfache Tabellen mit UDO
setzen zu lassen. Sie können festlegen, wie Spalten ausgerichtet
werden und wo horizontale oder vertikale Linien in der Tabelle
benutzt werden sollen.

Um mit UDO Tabellen zu setzen, benötigen Sie folgende Kommandos:

  1. !table_caption <text>
  2. !begin_table [...] {!hline}
  3. !end_table
  4. !hline
  5. !!

Das Kommando !table_caption legt die Überschrift der folgenden
Tabelle fest. !table_caption muß vor der table-Umgebung eingesetzt
werden, darf also nicht innerhalb dieser Umgebung stehen.

Das Kommando !begin_table leitet eine Tabelle ein. Das Ende der
Tabelle wird mit !end_table angegeben. Direkt nach !begin_table
können Sie angeben, wie die Spalten der Tabelle ausgerichtet werden
sollen (l=linksbündig, c=zentriert, r=rechtsbündig) und vor und nach
welchen Spalten vertikale Linien gezogen werden sollen (durch das
Symbol "|"). Folgt diesen Angaben noch das Kommando !hline, beginnt
die Tabelle mit einer horizontalen Linie.

Nachdem Sie das Format der Tabelle angegeben haben, folgt der ei-
gentliche Tabelleninhalt. Jede Tabellenzeile muß auch in einer
Textzeile angegeben werden, wobei die einzelnen Zellen durch ein
zwei Ausrufezeichen voneinander getrennt werden.

Möchten Sie eine horizontale Linie in der Tabelle ausgeben, so be-
nutzen Sie dazu das Kommando !hline. Dieser Befehl muß am Anfang
einer Zeile und alleine in dieser Zeile stehen.

Falls Sie die obigen Erklärungen mehr verwirrt haben sollten, als
Ihnen den Tabellensatz zu erläutern, so sehen sich einfach mal
folgendes kleines Beispiel an:

    !table_caption Tabellen mit UDO
    !begin_table [|l|c|r|] !hline
    oben links !! oben !! oben rechts
    unten links !! unten !! unten rechts
    !hline
    !end_table

Dieses Beispiel erzeugt folgende Tabelle, die aus zwei Zeilen und
drei Spalten besteht, wobei die erste Spalte linksbündig, die zweite
Spalte zentriert und die dritte Spalte rechtsbündig ausgegeben wird:


             +-------------+-------------+--------------+
             | links       |    mitte    |       rechts |
             | unten links | unten mitte | unten rechts |
             +-------------+-------------+--------------+

                    (Tabelle 2: Tabellen mit UDO)


Da vor und nach jeder Spalte ein "|" angegeben ist, werden die
Spalten durch vertikale Linien voneinander getrennt. Die Tabelle
beginnt mit einer horizontalen Linie, da bereits in der Zeile mit
!begin_table ein !hline angegeben wurde. Schließlich endet die
Tabelle mit einer horizontalen Linie, da vor !end_table wiederum ein
!hline angegeben wurde.


Hier noch ein weiters Beispiel einer Tabelle, die den gleichen Inhalt
zeigt, wie die obige Tabelle, aber bei der keine Linien benutzt
werden. Dies wird dadurch ermöglicht, indem man kein "|" und kein
!hline verwendet. Das Ergebnis:


                links           mitte           rechts
                unten links  unten mitte  unten rechts

                  (Tabelle 3: Ein weiteres Beispiel)



UDO bietet einen Schalter an, um die Linien der Tabelle nicht mit den
ASCII-Zeichen +, - und | zu erzeugen. Wird im Vorspann der Schalter
!use_ansi_tables benutzt, so werden die Linien der Tabelle mit Hilfe
der Grafikzeichen aus dem PC-Zeichensatz erzeugt. Auf die Formate
WinHelp, RTF, HTML und LateX hat dieser Schalter keinen Einfluß.


Hinweise:

   ∙ Tabellen werden immer zentriert ausgegeben.

   ∙ In HTML kann man die Benutzung von Linien nicht frei festlegen,
     daher werden Tabellen dort immer mit frame=box erzeugt, falls
     man in der Zeile mit !begin_table den Befehl !hline benutzt.

   ∙ Für WinHelp werden die Möglichkeiten zur Tabellenausgabe ausge-
     schöpft. Leider ist es hier nicht möglich, eine Tabelle
     zentriert auszugeben oder Linien frei zu setzen. Daher werden
     alle Zellen der Tabelle umrahmt dargestellt, falls man in der
     Zeile mit !begin_table das Kommando !hline benutzt. Benutzt man
     es nicht, wird die komplette Tabelle ohne Linien dargestellt.

   ∙ Bei RTF werden Tabellen momentan noch wie beim im ASCII-Format
     mit einem nichtproportionalen Zeichensatz ausgegeben.

   ∙ Beim ST-Guide werden die Tabellenlinien durch den Grafikbefehl
     @line erzeugt. Hier ist es nicht möglich, mehrere Linien
     zwischen den Spalten zu erzeugen, wenn man keine ANSI-Tabellen
     ausgeben läßt.

   ∙ In den Felder der Tabelle sind natürlich alle sonstigen UDO-
     Kommandos erlaubt. Sie können dort also auch Schriftarten,
     Querverweise, Indizes etc. verwenden.


5.5  Sonderzeichen
==================


5.5.1  Umwandlung von 8-bit-Zeichen
-----------------------------------

In einem Quelltext können Sie, anders als bei (!LateX), HTML, WinHelp
oder RTF, auch Zeichen aus dem oberen Teil Ihres Systemzeichensatzes
verwenden. Es ist also nicht erforderlich, sich zu überlegen, wie
denn wohl ein "ß" oder ein "ä" in der Ausgabedatei auszusehen hat;
UDO erledigt die Umwandlung für Sie automatisch.

UDO erwartet Quelltexte mit dem jeweiligen Systemzeichensatz. Nutzen
Sie UDO auf einem DOS-kompatiblen Rechner, so erwartet UDO Quell-
texte, die mit dem DOS-Zeichensatz geschrieben wurden. Die Atari-
Version erwartet Quelltexte mit Zeichen des Atari-Zeichensatzes usw.

Desweiteren gibt es die Möglichkeit, Teile eines Quelltextes (oder
natürlich auch den gesamten Quelltext) mit einem Editor unter Windows
zu erstellen. Diese Teile sind dann mit dem Schalter !code_ansi zu
markieren. Folgen wieder Passagen, die mit dem Systemzeichensatz
geschrieben wurden, ist dies mit Schalter !code_ascii zu
kennzeichnen.


Die Anpassung der Sonderzeichen hat jedoch ihre Grenzen. So kommen in
manchen Systemzeichensätzen Zeichen vor, die in anderen Zeichensätzen
fehlen können. So ist die Benutzung der Grafikzeichen des DOS-Zei-
chensatzes oder der hebräischen Zeichen des Atari-Zeichensatzes
problematisch, da diese zu systemspezifisch sind und in anderen
Formaten nicht nachgebildet werden können. UDO wird in einem solchen
Fall eine Fehlermeldung ausgeben. Sie sollten dann auf die Verwendung
dieser Zeichen verzichten.

Hinweis: Es kann durchaus sein, daß mit das eine oder andere Zeichen
"durch die Lappen" gegangen ist oder Zeichen falsch umgesetzt werden.
Sollten Sie auf solche Zeichen stoßen, so melden Sie mir dies bitte
unverzüglich. Vielen Dank!


5.5.2  Doppelte Anführungszeichen
---------------------------------

Doppelte Anführungszeichen werden bei der Umwandlung durch echte An-
führungszeichen (z.B. "Gänsefüßchen" unten und oben) ersetzt, falls
diese vom jeweiligen Format unterstützt werden. Werden diese nicht
unterstützt, so werden die doppelten Anführungszeichen durch einfache
ersetzt.

In der folgenden ASCII-Simulation wird gezeigt, wie das Ergebnis in
später aussehen kann, wenn das jeweilige Ausgabeformat echte Anfüh-
rungszeichen unterstützt.

    Echte ""Gänsefüßchen""

    Echte  Gänsefüßchen"
          "

Wenn Sie in der Ausgabedatei doppelte Anführungszeichen sehen
möchten, so müssen Sie stattdessen ""text"" angeben.

Die Umwandlung in echte Anführungszeichen kann man durch den Schalter
!no_quotes [...] im Vorspann ausschalten.


5.5.3  Doppelte Apostrophe
--------------------------

Genau wie bei doppelten Anführungszeichen paßt UDO auch hier doppelt
vorkommende Apostrophe an.

Aus...

    Hier stehen ''doppelte Apostrophe''.

... wird

    Hier stehen `doppelte Apostrophe'.

Wenn Sie in der Ausgabedatei doppelte Apostrophe sehen möchten, so
müssen Sie stattdessen ''text'' angeben.

Der Schalter !no_quotes [...] hat genau wie auf die doppelten Anfüh-
rungszeichen Einfluß auf die Umsetzung der doppelten Apostrophe.


5.5.4  Feste Leerzeichen
------------------------

Möchten Sie zwischen zwei Wörtern ein festes oder mehrere feste
Leerzeichen angeben, so benutzen Sie dafür die Tilde (~). Feste
Leerzeichen eignen sich (auch) dafür, den Zeilenumbruch an der
jeweiligen Stelle zu unterbinden.

Bei den Dateien, die im ASCII-Format ausgegeben werden und vom
zugehörigen Konverter nicht mehr nachformatiert werden, ersetzt UDO
die Tilde durch ein Leerzeichen und achtet selber darauf, wann kein
Zeilenumbruch erfolgen darf.

Bei den anderen Formaten ersetzt UDO die Tilde durch folgende for-
matspezifische Zeichenfolgen, die den gleichen Zweck erfüllen:

 LaTeX:   ~
 HTML:
 RTF:     \~
 WinHelp: \~


Wenn Sie die Tilde selber ausgeben möchten, so müssen Sie die Zei-
chenfolge !~ benutzen.

Hinweis: Genau dies wird bei HTML-Dokumenten gerne vergessen. Auch
bei einem externen Verweis muß die Tilde gequotet werden!


5.5.5  Gedankenstriche
----------------------

UDO bietet - wie sollte es auch anders sein - eine Möglichkeit,
Gedankenstriche (wie hier) bereits im Quelltext anzugeben.

Gedankenstriche werden von LaTeX, RTF und WinHelp unterstützt. Bei
den anderen Formaten werden zwei bzw. drei Minuszeichen durch eines
ersetzt.

Mit --- können Sie einen langen, mit -- einen kurzen Gedankenstrich
ausgeben. Wenn Sie drei Minuszeichen ausgeben möchten, so müssen Sie
im Quelltext (---) benutzen. Wenn Sie zwei Minuszeichen ausgeben
möchten, so müssen Sie im Quelltext (--) benutzen.


5.6  Silbentrennung
===================

UDO bietet für das ASCII-, ST-Guide-, Pure-C-Help- und Manualpage-
Format eine halbautomatische Silbentrennung. Halbautomatisch bedeu-
tet, daß Sie in einem Quelltext die Stellen markieren müssen, an
denen ein Wort getrennt werden darf.

Es gibt zwei Möglichkeiten, diese Trennstellen zu setzen:

  1. lokales Setzen durch Trennmarken ("!-")
  2. globales Setzen durch das Kommando !hyphen

Bei der Umwandlung ins LaTeX-Format werden die angegebenen Trenn-
stellen durch "\-" ersetzt. LaTeX weiß dann, daß das Wort nur an den
Stellen getrennt werden darf.

Bei der Umwandlung ins Rich Text, WinHelp- und HTML-Format werden die
Trennmarken einfach gefiltert.

Falls Sie die Zeichenfolge !- ausgeben möchten, so müssen Sie im Quell-
text !/- angeben.


5.6.1  Lokales Setzen von Trennstellen
--------------------------------------

Im Quelltext kann man in einem Wort durch "!-" die Stellen markieren,
an denen UDO (bzw. LaTeX) das Wort trennen darf. Ein Beispiel:

    eine halbautomatische Sil!-ben!-tren!-nung.

Bei der Umwandlung ins LaTeX-Format werden alle "!-" durch "\-" er-
setzt; es wird also "Sil\-ben\-tren\-nung" ausgegeben. Bei der Um-
wandlung ins ASCII-, ST-Guide-, Pure-C-Help- und Manualpage-Format
wird das Wort passend aufgetrennt, falls es nicht mehr komplett in
eine Zeile paßt (z.B. in "Sil- bentrennung" oder "Silben- trennung").
Bei allen anderen Ausgabeformaten werden die Trennmarken einfach
entfernt.


5.6.2  Globales Setzen von Trennstellen
---------------------------------------

Trennstellen können durch das Kommando !hyphen global gesetzt werden.
Global bedeutet, daß Sie die Trennstelle nur einmal im Vorspann des
Quelltextes angeben müssen, UDO dann bei der Umwandlung alle Zeilen
nach dem zugehörigen Wort durchsucht und die nötigen Anpassungen
durchführt.

Sobald in Ihrem Quelltext mehrere problematische Worte (also Worte,
die ungetrennt einen häßlichen rechten Flatterrand erzeugen) auftau-
chen, sollten Sie sich überlegen, ob es nicht vielleicht sinnvoller
ist, im Vorspann einmal !hyphen zu benutzen.

In diesem Beispiel wird davon ausgegangen, daß in Ihrem Quelltext das
Wort "Dokumentation" mehrfach auftaucht. Damit Sie nicht bei jedem
Wort die Trennstellen lokal setzen müssen, fügen Sie folgenden Zei-
le(n) in den Vorspann des Quelltextes ein:

    !hyphen Do!-ku!-men!-ta!-tio!-nen
    !hyphen Do!-ku!-men!-ta!-tion

In diesem Beispiel wurde zusätzlich der Trennvorschlag für den Plural
angegeben, da dieser anders getrennt werden muß. Der Plural muß, wenn
er angegeben werden wird, vor dem Singular stehen. Der Grund: UDO
speichert alle Trennvorschläge in einer Liste, die es bei der Um-
wandlung im FIFO-Prinzip (first in first out) abarbeitet.


5.6.3  Hinweise auf zu kurze Zeilen
-----------------------------------

Bei der Umwandlung ins ASCII-, Manualpage-, Pure-C-Help- und ST-
Guide-Format kann UDO durch seine halbautmatische Silbentrennung
dafür sorgen, daß im Ausgabetext ein relativ gleichmäßiger rechter
Rand erzeugt wird.

Dies ist dann nicht der Fall, wenn manche Zeilen zu kurz geraten. UDO
bemängelt diese Zeilen in der Logdatei und zeigt Ihnen dort auch das
Wort, welches durch seine Länge dazu führte, daß ein ungleichmäßiger
rechter Rand erzeugt wurde.

Versuchen Sie nun, durch Einsetzen von Trennmarken UDO zu erlauben,
dieses Wort zu trennen und damit einen gleichmäßigeren rechten Rand
zu erzeugen.

Tip: Durch den Befehl !sloppy werden die Hinweise auf solche kurzen
Zeilen ausgeschaltet. Durch den Befehl !fussy lassen sich die
Warnungen wieder einschalten. Gerade in der Entwicklungsphase einer
Dokumentation interessieren einen die Warnungen eher weniger.
Benutzen Sie dann einfach zu Beginn des Dokumentes den Befehl
!sloppy, so daß in der Logdatei nur noch die "wichtigen" Dinge zu
erkennen sind. Vor der Veröffentlichung der Dokumentation sollte man
dann den Befehl auskommentieren und die Formatierung überprüfen.


5.7  Bilder
===========

UDO ermöglicht die Eindbindung von Bildern in den Ausgabeformaten ST-
Guide, HTML, WinHelp und TeX. Dieses Kapitel soll Ihnen erläutern,
wie Sie die Einbindung realsieren können und welche Kommandos UDO im
jeweiligen Ausgabeformat erzeugt.

Zur Einbindung von Bilder bedient man sich des Kommandos !image, bei
dem man den Dateinamen der einzubindenden Datei (ohne Endung!) ange-
ben muß sowie optional eine Bildunterschrift angeben kann.

Um Bilder bei HTML und WinHelp mitten im Text zu plazieren, kann man
sich des Platzhalters (!image ...) bedienen. Bei den anderen Ausga-
beformaten ist es hingegen nicht möglich, Bilder mitten im Text
auszugeben. Eine genauere Erklärung dieses Platzhalters finden Sie im
Befehlsindex.


5.7.1  *.img & ST-Guide
-----------------------

Beispiel: !image tiger Ein Tiger

UDO öffnet die Datei tiger.img und ermittelt die Ausmaße des Bildes,
erzeugt in der Ausgabedatei das ST-Guide-Kommando @limage und fügt
dort einen Wert ein, um den das Bild eingerückt werden soll. Dieser
Wert wird ausgehend von der Breite eines Zeichens aus dem Stan-
dard-10pt-Systemfont berechnet.

Falls wie in diesem Beispiel eine Bildunterschrift angegeben wird,
wird diese, versehen mit "(Abbildung x: Ein Tiger)", ebenfalls
zentriert unter dem Bild ausgegeben.

Beachten Sie auch die Hinweise für das Lindner-TeX.


5.7.2  *.img & Lindner-TeX
--------------------------

Wenn man GEM-Images in ein LaTeX-File einbinden möchte, welches mit
dem Linder-TeX weiterverabeitet werden soll, so muß im Vorspann das
Kommando !tex_lindner gesetzt werden. Daran erkennt UDO, daß ein
spezielles Lindner-TeX-Makro zur Einbindung des Bildes erzeugt werden
soll.

UDO macht das dem Lindner-TeX beiliegende Zusatzprogramm namens
IMGTOTEX überflüssig! UDO beinhaltet alle Aufgaben, für die sonst
IMGTOTEX zuständig ist, nämlich das Eintragen bestimmter Auflö-
sungswerte in den Header des jeweiligen GEM-Images. Ein Beispiel:

    !tex_dpi 100
    !image tiger Ein GEM-Image

UDO liest zunächst den Header der Datei tiger.img ein, ermittelt
daraus die Ausmaße des Bildes und paßt den Header an 100 dpi an, was
für die spätere Ausgabe via DVI-Treibern wichtig ist. In der Zielda-
tei wird nun ein TeX-Makro mit Spezialbefehlen erzeugt, die die
Einbindung eines Bildes ermöglichen.


Hinweis: Bei 100 dpi erscheinen Screenshots (jedenfalls auf meinem HP
DeskJet 510) im Ausdruck in der Originalgröße. !tex_dpi kann vor
jedem Bild neu gesetzt werden, jedoch sollten das selbe Bild immer in
der gleichen Größe ausgedruckt werden, da der Image-Header jeweils
passend verändert wird.


5.7.3  *.img & CS-TeX/MultiTeX
------------------------------

Wenn man GEM-Images in ein LaTeX-File einbinden möchte, welches mit
dem CS-TeX oder MultiTeX weiterverabeitet werden soll, so muß im
Vorspann das Kommando !tex_strunk gesetzt werden.

Da die Treiber des CS-TeX auch die Spezialbefehle des Lindner-TeX
unterstützen, werden hier die gleichen Dinge durchgeführt wie bei der
Umwandlung für das Lindner-TeX.


5.7.4  *.msp & emTeX
--------------------

Um MSPs in einem emTeX-File einzubinden, müssen Sie im Vorspann den
Befehl !tex_emtex angeben sowie die Auflösung des jeweiligen
Ausgabegeräts mit !tex_dpi setzen.

Die Einbindung erfolgt gemäß der Beschreibung aus dvidrv.doc vom
emTeX.

UDO versucht bei der Angabe von !image tiger Ein Tiger die Datei
tiger.msp zu öffnen und die Ausmaße auszulesen. Schlägt dies fehl,
wird eine Fehlermeldung ausgegeben und stattdessen versucht,
tiger.pcx zu lesen.

Im Beispiel würde UDO folgendes Makro erzeugen (<w> und <h> werden
dabei durch die Ausmaße des Bildes ersetzt):

    \begin{figure}[htb]
    \begin{center}
    \begin{picture}(<w>,<h>)
        \put(0,<h>){\special{em:graph tiger.msp}}
    \end{picture}
    \end{center}
    \caption{Ein Tiger}
    \end{figure}

Hinweis: Bei einem HP DeskJet 510, der mit 300 dpi druckt, müssen Sie
!tex_dpi 300 benutzen. Den Auflösungswert können Sie für jedes Bild
neu setzen.


5.7.5  *.pcx & emTeX
--------------------

Um PCXe in einem emTeX-File einzubinden, müssen Sie im Vorspann den
Befehl !tex_emtex angeben sowie die Auflösung des jeweiligen
Ausgabegeräts mit !tex_dpi setzen.

Die Einbindung erfolgt gemäß der Beschreibung aus dvidrv.doc vom
emTeX.

UDO versucht bei der Angabe von "!image tiger Ein Tiger" die Datei
zunächst die Datei tiger.msp (nicht .pcx!) einzubinden. Erst wenn
diese Datei nicht existiert, versucht UDO die Ausmaße der Datei
tiger.pcx zu ermitteln und ein entsprechendes emTeX-Makro zu
schreiben.

Im Beispiel würde UDO folgendes Makro erzeugen (<w> und <h> werden
dabei durch die Ausmaße des Bildes ersetzt):

    \begin{figure}[htb]
    \begin{center}
    \begin{picture}(<w>,<h>)
        \put(0,<h>){\special{em:graph tiger.pcx}}
    \end{picture}
    \end{center}
    \caption{Ein Tiger}
    \end{figure}


Hinweis: Da UDO zunächst versucht, auf Grafiken im MSP-Format
zuzugreifen, erscheint im Logfile später eine Warnung. Diese können
Sie dann bei der Benutzung von PCX-Grafiken ignorieren.


5.7.6  *.gif & HTML
-------------------

UDO kann zur Einbindung von GIFs in eine HTML-Seite entsprechende
HTML-Kommandos erzeugen. UDO prüft dabei nicht, ob die angegebene
Datei existiert!

Anders als bei den anderen Formaten wird der zweite Parameter nicht
als Bildunterschrift, sondern als Alternativtext benutzt.

Aus dem UDO-Befehl "!image tiger Ein Tiger" wird folgender HTML-
Befehl erzeugt:

    <p align=center>
    <img src="tiger.gif" alt="(Abbildung 1: Ein Tiger)">
    </p><br>

Wird keine Bildunterschrift angegeben, so fehlt die Angabe des
Alternativtextes bzw. es wird ein leerer Alternativtext benutzt. Auch
hier das Beispiel zur Veranschaulichung: Aus "!image ../gif/tiger"
wird

    <p align=center>
    <img src="../gif/tiger.gif" alt="">
    </p><br>


5.7.7  *.bmp & WinHelp
----------------------

UDO kann Befehle zur Einbindung von Windows-Bitmaps in einen Windows-
Hilfetext ausgeben. UDO überprüft dabei nicht, ob die angegebene
Datei existiert!

Ein Bild kann mit oder ohne Bildunterschrift eingebunden werden. Die
Ausgabe des Bildes erfolgt jeweils zentriert.

  1. ohne Bildunterschrift: !image tiger

  2. mit Bildunterschrift: !image tiger Ein Tiger

UDO erzeugt dann folgenden RTF-Befehle:

    {\qc \{bmc tiger.bmp\}}\par\pard
    \par
    {\qc (Abbildung 1: Ein Tiger)}\par\pard


5.8  Miszellaneen
=================


5.8.1  Makros
-------------

Makros sind benutzerdefinierte Platzhalter, die sich für die ver-
schiedensten Dinge eignen. Auch hier zunächst ein paar Beispiele:

    !macro HTML Hypertext Markup Language
    !macro UDO  (!B)U(!b)niversal (!B)Do(!b)cument
    !macro TOSG (!T)UDO4GTOS.LZH(!t)
    !ifdest [html]
      !macro PICPATH gif/
    !else
      !macro PICPATH img/
    !endif
    [...]
    Die (!HTML) ...
    Das (!UDO) Format ...
    Das Archiv (!TOSG) ...
    !image (!PICPATH)/tiger

Diese Makros könnten dazu benutzt werden, sich lästige Tipparbeit zu
sparen oder Änderungen zu beschleunigen. Ein weiteres
Anwendungsgebiet ist das Erstellen von standardisierten Texten, deren
Inhalt durch Makros an den jeweiligen Quelltext angepaßt wird. Im
folgenden Beispiel wird der Programmname in einen Disclaimer
eingebaut, der per !include eingebunden wird:

    [doku.u]
    !macro PRG UDO
    [disclaim.u]
    (!PRG) wurde umfangreichen Tests unterzogen.
    Die Benutzung erfolgt auf eigene Gefahr!

Bei der Namensvergabe der Makros sollte man möglichst darauf achten,
diese nicht wie bereits existente Befehle oder Platzhalter zu
benennen. So sollten sie ein Makro nicht "B" oder "nl" benennen, da
dann die Umschaltung in Fettschrift ((!B)) oder ein erzwungener
Zeilenumbruch nicht mehr funktionieren.

Die Benutzung von Makros sollte nicht übertrieben werden. UDO erlaubt
zwar die Benutzung von bis zu 64 Makros, jedoch verlangsamt jedes
zusätzliche Makro die Umwandlung der Quelldatei, da jede Zeile nach
allen Makros durchsucht werden muß.


5.8.2  Definitionen
-------------------

Definitionen sind (wie Makros) benutzerdefinierte Platzhalter. Sie
können dazu dienen, im entgültigen Text spezielle Kommandos
einzubauen.

Die Syntax für eine Definition lautet !define <wort> <text>. Im
Gegensatz zu den Makros wird <text> nicht speziell angepaßt, d.h. es
werden keine Umlaute und andere Sonderzeichen angepaßt.

Im folgenden Beispiel benutzen wir eine Definition, um nur im HTML-
Format ein Wort als Überschrift auszugeben:

    !ifdest [html]
      !define H1 <H1>
      !define h1 </H1>
    !else
      !define H1
      !define h1
    !endif
    [...]
    (!H1)Eine Überschrift(!h1)


Wie Sie sehen, können Sie mit diesen Definitionen spezielle Befehle
des Ausgabeformates einbauen, die UDO standardmäßig nicht anbietet.
In UDO4 gab es mal einen Satz Spezialplatzhalter, die nur für LaTeX
vorhanden waren. Um diese nun nachzuahmen, kann man sich der
Definitionen bedienen:

    !ifdest [tex]
      !define ff "ff
      !define lb2 \linebreak[2]
    !else
      !define ff ff
      !define lb2
    !endif
    [...]
    Die Schi(!ff)ahrt
    LaTeX einen Umbruchstelle (!lb2) vorschlagen.


Wie bei den Makros sollten Sie aufpassen, daß sie keine von UDO
benutzten Platzhalter wie (!B), (!v), (!TeX) etc. verwenden. Auch
gibts es hier eine maximale Anzahl von benutzbaren Definitionen. Sie
liegt momenatan bei maximal 64 pro Quelltext.


5.8.3  Sprungmarken
-------------------

Mit dem Befehl !label können im Quelltext sogenannte Sprungmarken
("Labels") gesetzt werden. Ein Beispiel für ein solches Label:

    !label Beispiel

Bei den Hypertextformaten ST-Guide, HTML, WinHelp und Pure-C-Help
werden solche Sprungmarken automatisch referenziert. Bei WinHelp
werden diese Sprungmarken zusätzlich im Suchen-Dialog angegeben, beim
ST-Guide erscheinen sie im Index.

Im Beispiel könnte man dann im Hypertext von jedem Wort "Beispiel" an
die Stelle gelangen, an der diese Sprungmarke definiert wurde.

Die Umsetzung im Detail:

 HTML:          <a name="Beispiel"</a>
 LaTeX:         \label{Beispiel}
 Linuxdoc-SGML: <label id="Beispiel">
 Pure-C-Help:   sensitive("Beispiel") im Header
 ST-Guide:      @symbol ari Beispiel
 Turbo-Vision:  .topic Beispiel im Header
 WinHelp:       K{\footnote K Beispiel}
                #{\footnote # Beispiel}


Hinweis: In einem Label sollte man keine Sonderzeichen, Kommata,
Semikolen, Anführungsstriche oder Apostrophe benutzen, da dies bei
einigen der Ausgabeformate zu Problemen kommen kann. Versuchen Sie
bitte daher, ohne diese Sonderzeichen auszukommen. In den meisten
Fällen ist dies durchaus machbar.


5.8.4  Querverweise
-------------------

Manchmal möchte man auf andere Stellen der Dokumentation oder auf
andere Hypertexte oder Homepages verweisen. Um dies zu ermöglichen,
bietet UDO einen Satz von Befehlen für Querverweise.

Mit dem (!link ...)-Befehl können Sie Bezug auf andere Stellen im
aktuellen Dokument nehmen:

    UDO:      (!link [ein Wort] [der Verweis])
    HTML:     <a href="file.htm#der Verweis">ein Wort</a>
    LaTeX:    ein Wort (siehe \ref{der Verweis})
    ST-Guide: @{"ein Wort" link "der Verweis"}
    WinHelp:  {\uldb ein Wort}{\v der_Verweis}
    Turbo:    {ein Wort:der_Verweis}
    sonst:    ein Wort (siehe "der Verweis")

Bei der Umwandlung ins HTML- oder WinHelp-Format wird überprüft, ob
der benutzt Verweis vorhanden ist. Ist er es nicht, so gibt UDO eine
Fehlermeldung aus. Bei der Umwandlung ins LaTeX- oder ST-Guide-Format
sollten sie hingegen nur Querverweise auf existende Sprungmarken be-
nutzen, da UDO hier keine Überprüfung vornimmt, LaTeX und der HCP des
ST-Guide später jedoch sicherlich eine Fehlermeldung ausgeben werden.


Mit dem (!xlink ...)-Befehl können Sie Bezug auf Stellen anderer Hy-
pertexte oder Homepages nehmen. Der Unterschied zum obigen Befehl
besteht darin, daß beim zweiten Parameter bis auf die Tilde keine
Sonderzeichen angepaßt werden (bei Pfadangaben fatal!)

    UDO:      (!xlink [UDO] [*:\udo.hyp])
    ST-Guide: @{"UDO" link "*:\udo.hyp"}

    UDO:      (!xlink [Atari] [http://www.atari.com])
    HTML:     <A HREF="http://www.atari.com">Atari</A>

    UDO:      (!xlink [UDO] [Titel@d:/winhelp/udo.hlp])
    WinHelp:  {\uldb UDO}{\v Titel@d:/winhelp/udo.hlp}

    sonst:    UDO (bzw. Atari)


Speziell für LaTeX gibt es noch den (!plink ...)-Befehl, um Bezug auf
andere Seiten zu nehmen:

    UDO:   (!plink [Links] [Querverweise])
    LaTeX: Links (siehe Seite \pageref{Querverweise})
    sonst: Links


Speziell für WinHelp unf HTML gibt es darüber hinaus den (!ilink
...)-Befehl, um Verweise mit Darstellung eines Bildes zu erstellen.
Dieser Befehl ist eine Kombination aus (!link ...) und (!img ...) und
wird bei den anderen Formaten wie der oben besprochene Link-Befehl
behandelt:

    UDO:      (!ilink [img] [Text] [Verweis])
    WinHelp:  {\uldb \{bmc img.bmp\}}{\v Verweis}
    HTML:     <a href="Verweis"><img src="img.gif" alt="Text"></a>
    sonst:    analog zu (!link [Text] [Verweis])


Hinweise
--------

  1. Gerade bei den externen Verweisen für HTML wird gerne übersehen,
     daß man die Tilde "quoten" muß. Gibt man statt der Tilde nicht
     !~ an, so wird später versucht, auf eine URL mit Leerzeichen
     zuzugreifen, was sicherlich nicht gewollt war!

  2. Durch den Schalter !no_xlinks [...] können Sie im Vorspann
     angeben, bei welchen Formaten externe Verweise umgewandelt
     werden sollen. Dieser Schalter wird z.B. dann benötigt, falls
     man eine Seite mit Verweisen für das Internet angelegt hat, die
     in einem ST-Guide- oder WinHelp-Hypertext keinen Sinn machen
     würden.

  3. Falls innerhalb eines der Link-Befehle eine "(" oder "]" benutzt
     werden, so muß man diese quoten, damit UDO den Befehl korrekt
     umsetzen kann. Beispiel:

         Falsch:  (!link [Klammern])] [Verweis])
         Richtig: (!link [Klammern!]!)] [Verweis])
                                  ----

  4. Insgesamt dürfen in einem Absatz 200 Links benutzt werden. Wird
     diese Zahl überschritten, so gibt UDO eine Fehlermeldung aus,
     daß der Link nicht ersetzt werden konnte. Zur Erinnerung:
     Absätze werden durch Leerzeilen getrennt.


5.8.5  Indizes
--------------

Um in einem Quelltext Einträge für ein Indexregister anzugeben, gibt
es den Befehl !index und den Platzhalter (!idx ...). Indizes können
und sollten mehrfach angegeben werden.

Der Befehl zur Angabe eines Indexeintrags lautet folgendermaßen:

    !index Indexeintrag

Der Indexeintrag erscheint dann im Index von LaTeX, im Index des mit
Plain-TeX bearbeiteten Texinfo-Files sowie im Index des ST-Guide-Hy-
pertextes. Bei WinHelp erscheint der Indexeintrag im Suchen-Dialog.


Bei der Platzhalterversion können zwischen einem und vier Parameter
benutzt werden. Dieser Platzhalter wird derzeit nur für LaTeX und
umgesetzt. Die folgenden Beispiele zeigen, wie die Umsetzung nach
LaTeX erfolgt:

    UDO:   ein (!idx [Index])
    LaTeX: ein Index\index{Index}
    sonst: ein Index

    UDO:   ein (!idx [Wort] [Index])
    LaTeX: ein Wort\index{Index}
    sonst: ein Wort

    UDO:   ein (!idx [Wort] [Index] [Subindex])
    LaTeX: ein Wort\index{Index!Subindex}
    sonst: ein Wort

    UDO:   ein (!idx [Wort] [Index] [Subindex] [Subsubindex])
    LaTeX: ein Wort\index{Index!Subindex!Subsubindex}
    sonst: ein Wort

Die jeweiligen Parameter werden also durch eckige Klammern eingefaßt.
Falls man in einem Parameter eine schließende eckige oder runde
Klammer benutzen möchte, so muß deren Wirkung mit einem
Ausrufezeichen aufgehoben werden. Geschieht dies nicht, so denkt UDO,
der Parameter oder der Index-Befehl wäre bereits beendet. Ein
Beispiel:

    Falsch:  (!idx [Copyright (c) 1995] )
    Richtig: (!idx [Copyright (c!) 1995] )


5.8.6  Formatspezifisches
-------------------------

UDO bietet für jedes Ausgabeformat zwei Befehle und eine Umgebung,
mit denen es möglich ist, Zeilen nur dann auszugeben, wenn man in
eines der Formate umwandelt.

Bei diesen Befehlen und Umgebungen spielen Kürzel eine große Rolle.
Hier eine Übersicht, welches Kürzel für welches Ausgabeformat benutzt
werden kann:

 asc   ASCII
 html  HTML
 info  Texinfo
 ldoc  Linuxdoc-SGML
 man   Manualpage
 pch   Pure-C-Help
 rtf   RTF
 stg   ST-Guide
 tex   LaTeX
 tvh   Turbo-Vision-Help
 win   WinHelp

Es existieren nun je zwei Befehle für jedes Format, mit dem man
Zeilen, die nur für dieses Format bestimmt sind, und für Zeilen die
für alle außer dieses Format bestimmt sind, ausgeben kann. Die
Befehle ergeben sich, indem man den Kürzeln ein Ausrufezeichen bzw.
noch ein weiteres Gleichheitzeichen voranstellt.

Um beispielsweise eine Zeile nur in das ASCII-Format auszugeben, gibt
man folgendes an:

    !asc Diese Zeile erscheint nur im ASCII-Format

Um eine Zeile in allen Formaten außer dem ASCII-Format auszugeben,
gibt man folgendes an:

    !=asc Diese Zeile erscheint nicht im ASCII-Format

Der Inhalt dieser Zeilen wird ohne das Kommando selbst, ohne Berück-
sichtigung von UDO-Kommandos und ohne Umwandlung von Sonderzeichen
ausgegeben. Diese Zeilen sorgen - genau wie alle Kommandos - auch
dafür, daß ein Absatz beendet wird. Diese Kommandos eignen sich also
nicht dazu, mittem in einem Absatz unterschiedliche Sätze einzufügen!

Dieses Kommandos können dazu dienen, formatspezifische Kommandos
einzufügen. Im folgenden Beispiel wird gezeigt, welche Kommandos man
in einen Quelltext einfügen muß, damit LaTeX weiß, mit welchem Stil
ein Dokument auszudrucken ist und damit es einen Index erzeugt:

    !tex \documentstyle[11pt,german,makeidx]{article}
    !tex \makeindex
    [...]
    !tex \printindex


Nun kann es jedoch sein, daß man bestimmte Passagen speziell für nur
ein Ausgabeformat erstellen und dabei nicht auf die Möglichkeiten von
UDO, wie z.B. automatischen Zeilenumbruch oder Anpassung von Sonder-
zeichen, verzichten möchte. Auch daran wurde gedacht, denn durch die
Kommandos !ifdest und !ifndest kann man angeben, wofür die folgenden
Zeilen (nicht) gedacht sind. Auch hier kömmen die oben aufgeführten
Kürzel zum Einsatz. Desweiteren kann man nach !else angeben, was
ansonsten ausgegeben werden soll. Hier ein Beispiel für den ST-Guide
und WinHelp:

    !ifdest [stg,win]
      !title Der Hypertext zu
    !else
      !title Die Anleitung zu
    !endif

Alles, was zwischen !ifdest [stg] und !else bzw. !endif steht, wird
nur dann umgewandelt, wenn man ins ST-Guide- bzw. WinHelp-Format
umwandelt. Alles, was zwischen !else und !endif steht, wird nur dann
umgewandelt, wenn man nicht ins ST-Guide- oder WinHelp-Format
umwandelt.

Im Beispiel würde der Titel des Quelltextes "Der Hypertext zu"
lauten, wenn man ihn in einen ST-Guide-Hypertext bzw. Windows-
Hilfedatei umwandelt. Bei der Umwandlung in ein anderes Format würde
der Titel des Quelltextes auf "Die Anleitung zu" gesetzt.

Wie auch schon im Beispiel ersichtlich, lassen sich Passagen auch für
mehrere Formate gleichzeitig verwenden, indem man bei !ifdest die
gewünschten Kürzel in den eckigen Klammern angibt.

Das Kommando !ifndest funktioniert ähnlich wie !ifdest, es werden die
diesem Kommando folgenden Zeilen nur dann bearbeitet, wenn man nicht
in das/die angebene(n) Format(e) umwandelt. Im nächsten Beispiel wird
bei allen Formaten außer dem RTF eine Titelseite erzeugt.

    !ifndest [rtf]
    !maketitle
    !endif

Um Ihnen nun größere Passagen, die bereits in der speziellen Syntax
eines Ausgabeformats geschrieben wurden, einzubinden, könnte man nun
zu Beginn jeder Zeile einen der oben besprochenen speziellen Befehle
benutzen. Dies ist jedoch ausgesprochen lästig. Deshalb gibt es
seit UDO5 Abhilfe durch die sogenannte "raw-Umgebung", die mit
!begin_raw begonnen und mit !end_raw beendet wird. Zeilen, die
innerhalb dieser Umgebung stehen, werden direkt, also ohne Beachtung
von UDO-Befehlen und Umwandlung von Sonderzeichen, ausgegeben.

Mithilfe der oben besprochenen speziellen Befehle und dieser
speziellen Umgebungen lassen sich direkt im Quelltext spezifische
Anpassungen an das jeweilige Ausgabeformat durchführen. In dieser
Anleitung wurde davon z.B. zum Setzen der LaTeX-Preambel Gebrauch
gemacht.


5.8.7  Verteilte Dokumente
--------------------------

UDO stellt Ihnen die Kommandos !include, !vinclude und !rinclude zur
Verfügung, mit denen Sie die Möglichkeit erhalten, ein großes
Dokument in mehrere kleine Dateien aufzuteilen oder identische
Passagen mehrfach einzubinden.

Diese Dokumentation macht intensiven Gebrauch von dieser Möglichkeit.
Die Datei `udo.u' enthält lediglich wichtige Einstellungen und etli-
che !include-Kommandos, jedoch keine einzige Zeile "sichtbaren"
Textes.

!include kann sowohl im Vorspann als auch im Hauptteil benutzt wer-
den. Dadurch besteht die Möglichkeit sowohl, Makros und Trennvor-
schläge als auch Kapitel in externe Dateien auszulagern.

Um den Inhalt von Dateien als Klartext darstellen zu können, bedient
man sich des Kommandos !vinclude ("verbatim include"). Tip: Das
Kommando !vinclude eignet sich sehr gut, um Sourcecodes oder
Headerfiles darzustellen.

Falls man direkte Befehle für ein Format nachladen möchte, so kann
man sich des Kommandos !rinclude ("raw include") bedienen. Tip:
Dieser Befehl eignet sich im Zusammenhang mit dem !ifdest-Kommando
dazu, um z.B. spezielle LaTeX- oder HTML-Tabellen einzubinden.




Anhang A

FAQ
***

Die folgenden Abschnitte sollen Ihnen bei Fragen und kleineren
Problemen hilfreich zur Seite stehen. Außerdem finden Sie die
Antworten zu internen Fragen zu UDO. Zunächst finden Sie daher einige
allgemeine, später dann formatspezifische Fragen.


A.1  Allgemeine Fragen
======================

 Was bedeutet `FAQ'?

     "FAQ" bedeutet "Frequently Asked Questions" und bedeutet
     übersetzt soviel wie "häufig gestellte Fragen". Im übertragenen
     Sinn versteht man darunter eine Auflistung eben dieser oft
     gestellten Fragen samt der passenden Antwort.

 Wieso heißt UDO `UDO'?

     Als ich mit der Programmierung von UDO begann, brauchte ich
     einen Namen. Mir fiel auf die Schnelle nichts besseres ein als
     die Abkürzung "UDO", was als Abkürzung für "Universal DOcument"
     steht.

     Übrigens: Der Autor heißt mit Vornamen nicht Udo, sondern Dirk!

 Woher bekomme ich die aktuellen Versionen?

     Aktuelle Versionen von UDO können sich Besitzer eines Modems aus
     dem Gruppenprogrammteil UDO.Pub der Maus Iserlohn MK2 (++49 2371
     944925) downloaden. Auf neue Versionen wird in der MausNet-
     Gruppe ATARI.NEWS hingewiesen.

     Die aktuellen Versionen sind darüber hinaus auch per FTP
     erhältlich. Die Archive liegen im Verzeichnis
     members.aol.com/UDODH/ (nicht ftp.members.aol.com!).

     Noch einfacher ist es, in einem WWW-Browser die URL
     http://members.aol.com/UDODH/index.htm aufzurufen, auf der man
     die Links zu den jeweiligen Archiven findet.

     Interessenten, die kein Modem besitzen und keinen Zugriff auf
     FTP-Server oder das World Wide Web haben, können die aktuellen
     Versionen auch durch Einsenden einer formatierten Diskette samt
     adressierten und ausreichend frankierten Rückumschlags
     anfordern.

     Die Name der Archive der einzelnen Versionen haben jeweils einen
     bestimmten Aufbau:

         udorlyyy.sss
            ||| ||  |
            ||| |+--+--- .zip: Gepackt mit ST-ZIP oder PKZIP
            ||| |        .tgz: Mit gzip gepacktes tar-Archiv
            ||| |
            ||+-+------- lin:  Version für Linux
            ||           l68:  Version für Linux 68k
            ||           hpx:  Version für HP-UX
            ||           tos:  Version für Atari und Kompatible
            ||           dos:  Version für DOS, OS/2 und Windows
            ||           ami:  Version für Amiga
            ||           man:  Die Quelltexte dieser Dokumentation
            ||
            |+---------- g:    deutschsprachige Version
            |            e:    englischsprachige Version
            |
            +----------- Releasenummer: 5 für UDO Rel. 5

     Das Archiv mit der deutschsprachigen Atari-Version des Release 5
     würde also udo5gtos.tos lauten, das mit den englischsprachigen
     Quelltexten udo5eman.zip.

     Falls die Archive auf einem FTP-Server liegen, so können sie
     eventuell aussagekräftige Namen besitzen, z.B.
     udo5_ger_linux.tar.gz oder udo5_eng_hp-ux.tar.gz.

 Wird es Portierungen auf andere Systeme geben?

     Von UDO existieren zu diesem Zeitpunkt eine Atari-, DOS-, Linux-
     und HP-UX-Version. Versionen für den Commodore Amiga und Apple
     Macintosh wird in naher Zukunft (wahrscheinlich bis zum Mai)
     veröffentlicht.

     UDO wurde komplett in C geschrieben, verzichtet vollkommen auf
     betriebssystemspezifische Routinen. Dadurch könnte die
     Kommandozeilenversion von UDO theoretisch auf jedes
     beliebige System portiert werden, für das ein ANSI-C-Compiler
     existiert.

     Wenn Sie an einer Portierung auf ein bestimmtes System
     interessiert sind und einen Compiler für dieses System besitzen,
     so schreiben Sie mir (siehe "Dirk Hagedorn") einfach mal.

 Können auch `systemfremde' Formate erzeugt werden?

     Mit UDO kann auf man jedem System natürlich auch Formate für
     andere Betriebssysteme erzeugt werden, da die Versionen
     identisch sind. So ist es möglich, mit der Atari-Version
     WinHelp-Quelltexte zu erzeugen oder unter OS/2 mit der DOS-
     Version ST-Guide-Quelltexte.

     Lediglich eine Umsetzung der Sonderzeichen muß ggf. erfolgen.
     Dies kann man z.B. mit GNU-recode durchführen. Auf Wunsch gibt
     es auch bei mir (siehe "Dirk Hagedorn") ein Programm zur
     Umsetzung der Sonderzeichen in Textdateien.

 Kommen in Zukunft weitere Ausgabeformate hinzu?

     Vielleicht. Mich selbst würde das Acrobat-Format oder generell
     das Postscript-Format interessieren. Falls ich irgendwo mal eine
     Doku zu diesen Formaten finden sollte, werde ich sehen, ob eine
     Ausgabe dieser Formate durch UDO möglich ist.

     Desweiteren dürfte für einige Leute das OS/2-Book-Format
     interessant sein. Leider liegen mir keine weiteren Informationen
     zu diesem Format vor, was die Unterstützung natürlich etwas
     erschwert. ;-)

     Aber: Neue Ausgabeformate werden erst dann von mir in Angriff
     genommen, wenn die bisherigen korrekt und möglichst komplett
     unterstützt werden.

 Kann sich die UDO-Syntax noch ändern?

     UDO ist noch nicht fertiggestellt, was Sie unschwer an der Ver-
     sionsnummer (kleiner als 1.0) erkennen können. In Zukunft werden
     sicherlich noch weitere Kommandos hinzukommen. Teilweise wird es
     sich auch nicht vermeiden lassen, die Syntax einiger Kommandos
     zu verändern, wenn es sinnvoll sein sollte. Auf Änderungen an
     der Syntax wird dabei speziell hingewiesen, so daß eine
     Anpassung der eigenen Quelltexte in ein paar Minuten vollzogen
     werden kann.

 Wie funktioniert UDO?

     UDO liest die Quelldatei(en) in zwei Durchgängen ein.

     Im ersten Durchgang werden Schalter, Makros, Definitionen sowie
     die Namen der Kapitel für das Inhaltsverzeichnis und die
     automatische Referenzierung ermittelt.

     Im zweiten Durchgang erfolgt dann das die Konvertierung und
     Formatierung des Textes. UDO speichert bis zum Eintreffen einer
     Leerzeile bzw. eines Kommandos den Text in einem internen Puffer
     und gibt dann den eingelesenen Absatz aus bzw. führt das
     jeweilige Kommando aus.

     Aus dem letzten Satz folgt: Leerzeilen und Kommandos unterteilen
     Absätze.

 Wie referenziert UDO?

     UDO legt bei den Hypertext-Formaten (außer beim ST-Guide-Format)
     im Text automatisch Referenzen zu Kapiteln und Sprungmarken an.
     Es werden dabei nur Verweise auf "andere" Seiten angelegt, also
     keine Verweise auf Stellen der aktuellen Seite.

     Mit dem Schaltern !autoref kann man die automatische
     Referenzierung aus- (Parameter [off] und wieder einschalten
     (Parameter [on]).

     Da UDO nicht auf der Seite Verweise anlegt, auf der ein Label
     gesetzt wurde, gibt es ein Problem, falls man am Seitenende
     einen Verweis zum Seitenanfang anlegen will. Daher muß man hier
     einen manuellen Link setzen.

     !node  Test
     !label Test Anfang
     [...]
     (!link [Zum Seitenanfang] [Test Anfang])


A.2  Fragen zum ASCII-Format
============================

 Ist eine Aufteilung in mehrere Dateien geplant?

     Bisher hat erst ein (unregistrierter) Benutzer den Wunsch
     geäußert, daß UDO wie bei HTML Kapitel etc. in eigene Dateien
     ausgeben soll. Da dieser Wunsch bisher einmalig war, bin ich ihm
     nicht nachgekommen.

     Sollte jedoch der Bedarf vorhanden sein, bin ich gerne bereit,
     eine solche Option in UDO einzubauen. Die Routinen sind quasi
     fertig und müssen nur noch für ASCII angepaßt werden.

 Manche Zeilen sind länger als 70 Zeichen, warum?

     Dies sind die Zeilen, in denen Sie Texthervorhebungen wie
     Fettschrift, kursive oder unterstrichene Wörter benutzt haben.
     Diese Hervorhebungen werden durch die Zeichen *, / und _
     geschaffen, wie sie in der DFÜ üblich sind.

     Da einige Druckprogramme (z.B. IdeaList für den Atari ST) diese
     Hervorhebungen in Druckerbefehle umwandeln können bzw. einige
     Frontends diese Hervorhebungen unterstützen, zählt UDO diese
     Zeichen bei der Längenermittlung nicht mit.


A.3  Fragen zum HTML-Format
===========================

 Wie kann man die Aufteilung in mehrere Dateien unterbinden?

     Im Gegensatz zu den anderen Formaten erzeugt UDO standardmäßig
     mehrere Dateien, die miteinander verknüpft sind. Für jedes
     Kapitel, jeden Abschnitt und Unterabschnitt wird eine eigene
     Datei mit der Endung .htm[l] angelegt. Die Namen der einzelnen
     Dateien richten sich nach der Nummer und der Position des
     jeweiligen Kapitel. Inhaltsverzeichnis und Titelseite gelangen
     in die Datei, die Sie UDO per Kommandozeile als --outfile
     übergeben.

     Mit den Schaltern !html_merge_nodes, !html_merge_subnodes oder
     !html_merge_subsubnodes können Sie die Aufteilung in mehrere
     Dateien unterbinden.

     Wird im Vorspann !html_merge_nodes benutzt, so wird das gesamte
     Dokument in einer Datei gesichert. Dies empfiehlt sich lediglich
     bei kleinen Dokumenten, die kleiner als 16 KB sind.

     !html_merge_subnodes sorgt dafür, daß alle Abschnitte eines
     Kapitels in der Datei angegeben werden, in dem sich auch das
     Kapitel selbst befindet.

     Der Schalter !html_merge_subsubnodes schließlich sorgt dafür,
     daß alle Unterabschnitte im gleichen File wie der übergeordnete
     Abschnitt untergebracht werden.

 Mir gefallen die Dateinamen bei der HTML-Ausgabe nicht!

     Durch den Befehl !htmlname können Sie einem Kapitel einen
     bestimmten Namen zuweisen, den UDO für die jeweilige Datei
     anstelle der etwas kryptischen Namen wie etwa "c_0a1009.htm"
     benutzt.

 Wie bekommt man diese scheußlichen Kopfzeilen weg?

     UDO erzeugt standardmäßig auf jeder HTML-Seite eine Kopfzeile,
     anhand derer man das Thema (gebildet aus den Daten von !title
     und !program) des Hypertextes erkennen kann. Desweiteren werden
     Links zu der vorgehenden, nachfolgenden und/oder übergeordneten
     Seite angelegt. Dazu werden GIFs benutzt, die UDO automatisch
     erzeugt. Die Dateinamen dieser GIFs lauten udo_lf.gif,
     udo_rg.gif und udo_up.gif.

     Durch den Schalter !no_headlines [html] kann die Ausgabe der
     Kopfzeilen und der Grafiken unterbunden werden.

 Wie kann man bequem eigene Kopf- und Fußzeilen erzeugen?

     Um eigene Kopf- und Fußzeilen zu erzeugen, kann man Makros be-
     nutzen, die man jeweils am Anfang und Ende eines Kapitels
     angibt. Der Inhalt dieser Kapitel erscheint dabei jedoch
     unterhalb der Überschrift. Auf folgende Art und Weise wurden
     beispielsweise Kopf- und Fußzeilen meiner WWW-Homepage angelegt,
     in der es Kapitel namens "Software", "Kontaktadressen" und
     "Links" gibt:

      Hauptdatei:

          !ifdest [html]
          !define HR <hr>
          !define ADR <address>
          !define adr </address>
          !macro  HEAD [ Software | Kontaktadressen | Links ] (!HR)
          !macro  FOOT (!ADR)Dirk Hagedorn - Letzte Änderung (!short_today)(!adr)
          !else
          !define HR
          !define ADR
          !define adr
          !macro  HEAD
          !macro  FOOT

      software.ui:

          !node Software
          !htmlname software
          (!HEAD)
          [...]
          (!FOOT)

     Wird nun nach HTML umgewandelt, so werden die jeweiligen Kopf-
     und Fußzeilen ausgegeben. Durch die Referenzierung von UDO
     werden automatisch Links auf die anderen Kapitel angelegt.

     Wandelt man nicht nach HTML um, so werden leere Definitionen und
     Makros erzeugt, wodurch keine Kopf- und Fußzeilen ausgegeben
     werden.


A.4  Fragen zum Manualpage-Format
=================================

Das Manualpage-Format ist eigentlich ein ASCII-Format, bei dem
lediglich Schriftarten durch Backspace-Sequenzen erzeugt werden. Es
findet seinen Einsatz zur Beschreibung der Tools eines Unix-Rechners.

Hier fehlt noch etwas...


A.5  Fragen zum LaTeX-Format
============================

Hier fehlt noch etwas...


A.6  Fragen zum Linuxdoc-SGML-Format
====================================

Dieses Format war mir bis Mitte März 1996 völlig unbekannt. Dann fand
ich darüber einen Artikel in der Zeitschrift "iX", habe diesen kurz
durchgelesen, habe mir das Archiv gesaugt, die Dokumentation
durchgelesen (zu einer Installation ist es mangels Linux-Rechner
nicht gekommen) und dieses Format binnen zwei Stunden eingebaut.
Mangels Testmöglichkeiten war es mir nicht möglich, zu überprüfen, ob
UDO richtiges Linuxdoc-SGML erzeugt, ich habe mich allerdings strikt
an die Vorgaben des User's Guide gehalten.

Linuxdoc-SGML ist genau wie UDO ein Multiformat-Konverter, das auch
sein eigenes Format in LaTeX, Manualpage, RTF, HTML und Texinfo
umwandeln kann. Nicht ganz ohne Stolz möchte ich aber darauf
hinweisen, daß UDO gegenüber Linuxdoc-SGML 1.5 leistungsfähiger und
auch leichter zu begreifen ist. Auch die Installation von UDO
gestaltet sich wesentlich einfacher als die von Linuxdoc-SGML, welche
hier wohl nur etwas für absolute Unix-Freaks ist. Allerdings kann
sich das hier gesagte bei dem Entwicklungstempo, was man von der
Linux-Szene kennt, sehr schnell ändern.

 Die xlist-Umgebung wird als description-Umgebung ausgegeben!?

     Beim Linuxdoc-SGML-Format ist eine xlist-Umgebung nicht
     vorgesehen. Daher wird diese Umgebung hier als description-
     Umgebung behandelt, welche der xlist-Umgebung am ähnlichsten
     ist.


A.7  Fragen zum Pure-C-Help-Format
==================================

Das Pure-C-Help-Format wird lediglich für Pure C, einem Compiler für
den Atari ST, als Hilfesystem verwendet. Ansonsten hat es keine
Bedeutung mehr für diesen Rechner.

 Wie erzeugt UDO hier Titelseite und Inhaltsverzeichnis?

     UDO erzeugt eine Seite mit den Titelangaben und dem Inhalts-
     verzeichnis. Da diese Seite bei umfangreicheren Dokumenten
     ziemlich lang werden kann, empfiehlt es sich, den Schalter
     !use_short_toc [pch] im Zusammenhang mit den Schaltern
     !use_auto_subtocs [pch] und !use_auto_subsubtocs [pch] zu be-
     nutzen, damit auch Programmierer mit kleinen Bildschirmen nicht
     den Überblick auf dieser Seite zu verlieren.

 Wie kann ich bei Pure-C-Help die Kopfzeilen entfernen?

     UDO erzeugt auf jeder Seite automatisch eine Kopfzeile, gebildet
     aus der Überschrift der jeweiligen Seite sowie des Titels der
     Hilfedatei. Durch Anklicken des Titels kann man zur Titelseite
     bzw. zum Inhaltsverzeichnis verzweigen.

     Durch den Schalter !no_headlines [pch] läßt sich die Ausgabe
     dieser Kopfzeilen unterbinden.

 Und wie die Fußzeilen?

     UDO erzeugt auf jeder Seite automatisch Fußzeilen, in denen
     Verweise auf das vorherige, nachfolgende und/oder übergeordnete
     Kapitel zu finden sind. Diese ermöglichen dem Leser, direkt zu
     anderen Kapiteln des Textes zu verzweigen.

     Durch den Schalter !no_bottomlines [pch] läßt sich die Ausgabe
     dieser Kopfzeilen unterbinden.

 Wofür ist diese Projektdatei?

     UDO legt während der Umwandlung eine Projektdatei für den
     Helpcompiler von Pure C an, welche an diesen zur Erzeugung der
     Helpdatei als Kommando übergeben werden muß.

     UDO überschreibt diese Datei ohne Rückfrage. Um manuelle
     Änderungen an dieser Datei zu bewahren, müssen Sie die Datei
     schreibschützen.


A.8  Fragen zum Rich Text Format
================================

Das Rich Text Format (kurz: RTF) dient zum systemweiten Austausch von
Texten. Dieses Format hat eine klare Definition und kann laufend um
neue Kommandos erweitert werden. Importiert ein Programm auf einen
unbekannten RTF-Befehl, so ist dieser zu ignorieren. Leider handeln
nicht alle Programme so, sondern interpretieren irgendwelchen Unsinn.
Selbst Microsoft Word scheint das im eigenen Hause entwickelte Format
nicht ganz zu verstehen.

 Wieso erzeugt UDO beim RTF kein Inhaltsverzeichnis?

     Sicherlich möchten Sie oder jemand anderes die RTF-Datei mit
     einer Textverarbeitung ausdrucken und dann auch wissen, auf
     welcher Seite ein Kapitel zu finden ist.

     Und weil UDO nicht wissen kann, auf welcher Seite später ein
     Kapitel zu finden ist, erzeugt es kein Inhaltsverzeichnis.

     Sicher, es wäre kein Problem, dieses auszugeben, allerdings
     würden dann die Seitennummern fehlen, und ich kann mir kaum
     vorstellen, daß dies gewünscht wird.

 Wieso kann UDO keine Bilder in ein RTF-File einbinden?

     Ich weiß noch nicht, wie man Bilder in eine RTF-Datei einbaut.
     Sobald ich dies erfahren habe, werden auch beim RTF Bilder
     unterstützt.

 Meine Textverarbeitung zeigt nur Müll an!?

     Tja, dann haben Sie halt Pech gehabt, denn UDO erzeugt RTF-
     Dateien, die sich strikt an die RTF-Definition halten. Falls es
     möglich ist, Kontakt zu den Autoren der Textverarbeitung
     aufzunehmen, schicken Sie denen die RTF-Datei und verlangen Sie
     Besserung.

     Übrigens: Dies habe ich schon selbst versucht, aber bis auf
     Herrn Christian Nieber von R.O.M.-Logicware (Papyrus) hat mir
     niemand Beachtung geschenkt. Traurig!

 Die Umlaute kommen beim RTF nicht richtig an?

     UDO erzeugt RTF-Dateien mit dem PC-Zeichensatz. Jede
     Textverarbeitung sollte mit Dateien klarkommen, die im PC-,
     Ansi- und Mac-Zeichensatz erstellt wurden. Dies ist kein Problem
     von UDO, sondern ebenfalls von der benutzten Textverarbeitung.

 Die deutschen Anführungszeichen werden falsch dargestellt?

     Dies ist tatsächlich ein Problem, da diese beim PC-Zeichensatz
     keine feste Position haben. Falls die bei Ihnen nicht richtig
     dargestellt werden, gibt es zwei Möglichkeiten, dieses Problem
     zu beheben:

       1. Mappen Sie den benutzten Zeichensatz passend um oder

       2. setzen Sie im Vorspann den Schalter !no_quotes [rtf]

 Atari Works mag eine RTF-Datei nicht einlesen?

     Der RTF-Import von Atari Works ist - gelinde gesagt - eine
     Katastrophe. Da die Firma Atari (der Rechner schon noch) sich
     aus der Rechnerwelt zurückgezogen hat, ist hier sicherlich keine
     Besserung mehr in Sicht. Abhilfe: Kaufen Sie sich eine gescheite
     Textverarbeitung. Ich empfehle Papyrus.

 That's Write stürzt beim Einlesen von RTF ab!?

     Das liegt an That's Write, das entgegen den Aussagen der
     Programmierer große Probleme mit etwas längeren RTF-Dateien hat.
     Tip: Schalten Sie vor dem RTF-Import die Wörterbuchfunktion ab.
     Und wenn Sie dann Glück haben, bekommen Sie mit That's Write
     sogar etwas ordentliches dargestellt.


A.9  Fragen zum ST-Guide-Format
===============================

 Warum erscheinen Bilder bei mir nicht zentriert?

     Bisher besteht keine Möglichkeit, dem ST-Guide mitzuteilen, daß
     er Bilder zentriert anzeigen soll. Stattdessen muß man die
     Koordinaten des Bildes fest angeben. Diese werden momentan
     speziell für einen nichtproportionalen 10pt-Font errechnet, und
     es wird damit nur hier eine annähernde Zentrierung erreicht.

     Nutzen Sie nun zum Lesen des Hypertextes einen kleinen und/oder
     proportionalen Font, so werden Bilder nicht mehr zentriert
     angezeigt.

     Holger Weets, der Autor des ST-Guide, hat jedoch Abhilfe
     versprochen, weshalb dieses Problem bald der Vergangenheit
     angehören sollte.

 Wie werden die Titelseite und das Inhaltsverzeichnis erzeugt?

     Titelseite und Inhaltsverzeichnis werden jeweils auf einer
     eigenen Seite dargestellt. Die Titelseite hat dabei den Namen
     "Titel", dem Inhaltsverzeichnis wird dabei der primäre Name
     "Main" zugewiesen.

     Um den ST-Guide die erste Seite des Hypertextes (was meistens
     die Titelseite sein wird), übergibt man einfach den Namen des
     erzeugten Hypertextes. Um das Inhaltsverzeichnis darzustellen,
     übergibt man zusätzlich "Main". Wie man dem ST-Guide mitteilt,
     welche Seite welchen Hypertextes anzuzeigen ist, findet man in
     der Beschreibung zum HCP.

 Wie entferne ich die Kopfzeilen?

     UDO erzeugt standardmäßig auf jeder Seite eine Kopfzeile,
     gebildet aus dem Titel und dem Namen des im Hypertext
     besprochenen Programms. Die Kopfzeilen werden unterstrichen
     dargestellt.

     Durch den Schalter !no_headlines [stg] läßt sich die Ausgabe
     dieser Kopfzeilen unterbinden.

 Wie wird beim ST-Guide referenziert?

     Die Referenzierung wird fast komplett dem HCP des ST-Guide
     überlassen. Lediglich bei den manuell gesetzten Links durch die
     Befehle (!link ...) und (!xlink ... setzt UDO explizite
     Querverweise auf andere Kapitel oder Labels.

 Wie werden Labels umgesetzt?

     UDOs Befehl !label wird in den HCP-Befehl "@symbol ari"
     umgesetzt. Dabei ist zu beachten, daß noch kein anderes Kapitel
     oder Label mit gleichem Namen existiert, da der HCP dies
     bemängeln würde.

     Labels werden (wie bei den anderen Formaten auch) automatisch
     referenziert und gelangen darüber hinaus auch in den Index des
     Hypertextes.

 Wie können Popup-Nodes erzeugt werden?

     Durch die Befehle !pnode etc. können Kapitel im ST-Guide als
     Popups dargestellt werden. Dabei ist folgendes zu beachten:

     Beim ST-Guide dürfen in einem Popup lediglich 12 Zeilen mit
     maximal 60 Zeichen stehen. Außerdem dürfen in einem Popup keine
     Bilder oder Verweise benutzt werden.

     UDO bricht Zeilen eines Popup-Nodes auf 60 Zeichen um, achtet
     aber nicht darauf, ob man zuviele Zeilen, Verweise oder Bilder
     benutzt hat.

 Der HCP meldet mir den Fehler "please add..."?

     Falls der HCP die Fehlermeldung "please add a @subject-command
     to this text" am Ende der Übersetzung des erzeugten ST-Guide-
     Quelltextes erzeugt, so haben Sie vergessen, im Vorspann des
     UDO-Quelltextes folgenden ST-Guide-Spezialbefehl anzugeben:

         !stg @subject "..."

     Anstelle der Punkte müssen Sie die Rubriken angegeben werden, in
     die ein Hypertext eingeordnet werden kann. Bei einem kleinen
     Tool geben Sie z.B. "Dokumentation/Utilities" an. Weitere
     Informationen zu diesem Thema findet man in der Dokumentation
     des ST-Guide.


A.10  Fragen zum Texinfo-Format
===============================

Texinfo hat in der GNU-Welt eine große Bedeutung. Texte, die im
Texinfo-Format erstellt werden, können mit Plain-TeX als sauber
gesetzte Anleitung ausgedruckt werden bzw. mit `Makeinfo' in einen
Hypertext umgewandelt werden, welchen man sich mit `Info' anzeigen
kann.

UDO erzeugt auf Systemen, auf denen nur ein 8+3-Dateisystem zur
Verfügung steht, die Dateiendung .tex. Stehen lange Dateinamen zur
Verfügung, wird .texi benutzt.

 Warum werden bei Texinfo die Kapitelnamen verändert?

     Makeinfo oder Info bekommen Probleme, falls im Namen eines
     Kapitels Sonderzeichen wie Klammern, Kommata oder (Doppel-
     )Punkte auftauchen. UDO entfernt daher diese Sonderzeichen.

     Formatiert man das Texinfo-File mit TeX, so tauchen diese
     Sonderzeichen in den Kapitelüberschiften selbstverständlich auf.

     Hier fehlt noch etwas...


A.11  Fragen zum Turbo-Vision-Help-Format
=========================================

Dieses Format wird benutzt, um Onlinehilfen für Programme zu
erstellen, die mit Borlands Turbo-Vision-Library geschrieben wurden.
Zuständiger Konverter ist das Programm TVHC.EXE, das den
Entwicklungssystemen auch im Sourcecode beiliegt.

Scheinbar gibt es jedoch von diesem Konverter verschiedene Versionen,
die unterschiedliche Hilfedateien erzeugen. Daher war es mir bis
heute nicht möglich, die Korrektheit der Ausgaben von UDO zu
überprüfen.

Falls dies demnächst doch der Fall sein sollte, werden hier auch
Probeleme ausführlicher besprochen.


A.12  Fragen zum WinHelp-Format
===============================

 WinHelp meint, daß *.rtf und *.hpj keine Hilfedatei sei?

     Weder die eine noch die andere Datei ist eine fertige Hifedatei
     für Windows. UDO erzeugt lediglich die Quelltexte einer
     Hilfedatei, welche noch mit einem Hypertext-Compiler (HC.EXE)
     übersetzt werden muß.

 Woher bekomme ich HC31.EXE?

     HC31.EXE, der Hypertextcompiler für WinHelp-Dateien, ist meines
     Erachtens nicht Freeware. Microsoft und Borland scheinen dieses
     Programm nur Ihren Entwicklungssystemen für Windows beizulegen.
     Es bleibt einem also nichts anderes übrig, als bei diesen Firmen
     die Konditionen zu erfragen, zu denen man dieses Programm auch
     ohne Entwicklungssystem erhalten kann.

 Warum will der HC einfach keine HLP-Datei erzeugen?

     Dafür kann es mehrere Gründe geben. In den meisten Fällen liegt
     es daran, daß Sie im UDO-Quelltext Fehler gemacht haben, die UDO
     jedoch nicht erkannt hat. Beachten Sie auf jeden Fall auch die
     Kommentare im zugehörigen Logile mit der Endung ulw und denken
     Sie immer daran, die Kommandos !begin_document und !end_document
     zu benutzen.

     Falls man den Fehler nicht sofort finden sollte, so hilft es in
     einigen Fällen, wenn man am Ende des erzeugten RTF-Files eine
     oder mehrere geschweifte Klammern "}" hinzufügt.

 Wofür ist die Datei mit der Endung `hpj'?

     UDO erzeugt automatisch eine zum Hypertext gehörende
     Projektdatei mit der Endung .hpj, die dem HC übergeben werden
     muß, um aus dem Quelltext eine fertige WinHelp-Datei zu
     erstellen.

     In dieser Projektdatei befinden sich Informationen wie der Titel
     des Hypertextes, die zusätzlichen Schaltflächen, die Ausmaße des
     Fensters nach dem Öffnen des Hypertextes etc.

     UDO überschreibt vorhandene Projektdateien ohne Rückfrage. Wenn
     Sie manuelle Änderungen an einer Projektdatei vorgenommen haben
     und diese beibehalten möchten, so schreibschützen Sie die
     Projektdatei.

 Wie werden hier die Kopfzeilen erzeugt?

     UDO erzeugt auf jeder Seite (mit Ausnahme der Titelseite und des
     Inhaltsverzeichnisses) eine Kopfzeile. In dieser befindet
     sich der Name des jeweiligen Kapitels. Kopfzeilen werden als
     "non-scrolling-regions" angelegt, so daß man auch nach dem
     Scrollen der Seite immer noch den Kapitelnamen erkennen kann.

     Durch den Schalter "!no_headlines [win]" werden diese "non-
     scrolling-regions" nicht erzeugt, beim Scrollen einer Seite wird
     also die Kapitelüberschrift mit verschoben.

 Wie werden die Kontextstrings ermittelt?

     Falls Sie von anderen WinHelp-Files auf ein mit UDO erzeugtes
     WinHelp-File verzweigen möchten, müssen Sie den Kontextstring
     des Kapitels kennen.

     WinHelp erlaubt in Kontextstrings keine Sonderzeichen. UDO
     wandelt daher die Namen der Kapitel folgendermaßen in
     Kontextstrings um:

       1. Zunächst werden wie sonst auch Sonderzeichen durch die RTF-
          Schreibweise ersetzt.

       2. Leerzeichen werden in Unterstriche umgewandelt.

       3. Alle anderen Zeichen (ausgenommen Ziffern und die
          Buchstaben des Alphabets) werden durch Ihren hexadezimalen
          Wert in großer Schreibweise mit einem vorangehenden
          Unterstrich ersetzt.

     Ein Beispiel:

         UDO:     !node LaTeX-Einführung Teil 1
         WinHelp: #{footnote # LaTeX_2DEinf_5C_27FChrung_Teil_1}

     Erläuterungen:

       1. Das Minuszeichen entspricht ASCII "0x2D", daher wird es
          durch "_2D" ersetzt.

       2. Das "ü" in Einführung lautet in RTF-Schreibweise "\'FC."
          "\" entspricht "0x5C", wird also durch "_5C" ersetzt. "'"
          enspricht "0x27", wird also durch "_27" ersetzt.

       3. Die Leerzeichen werden durch "_" ersetzt.

     Siehe sehen, daß aus einem "ü" die ziemlich lange Zeichenfolge
     "_5C_27FC" wird. Dies scheint auf den ersten Blick mehr als
     umständlich und "doppelt gemoppelt" zu sein, bringt aber den
     Vorteil, daß die Vergabe von gleichen Kontextstrings bei
     ähnlichen Kapitelnamen ziemlich unwahrscheinlich wird. Würde aus
     dem "ü" lediglich "FC" gemacht, wären Probleme vorprogrammiert.

 Warum werden Tabellen nicht zentriert?

     Entweder ist dies wirklich nicht möglich, Tabellen zentriert
     auszugeben, oder aber ich habe bei meiner viertägigen Suche die
     entscheidende Möglichkeit übersehen.

 Warum sind die Einrückungen bei Listen und Tabellen so groß?

     UDO kennt die Zeichenbreiten der benutzten Zeichensätze nicht.
     Daher benutzt es einen konstanten Wert für jedes Zeichen. Damit
     ist die Einrückung auch bei kursiver fetter Großschrift passend,
     bei reiner Proportionalschrift ist die Einrückung und auch die
     Breite der Tabellenspalten etwas zu groß, was jedoch eher zu
     verschmerzen ist, als eine zu geringe Einrückung oder
     Spaltenbreite.



Anhang B

Bekannte Fehler
***************

 Schriftarten in Indizes: In Indizes können derzeit keine
     Schriftarten gesetzt werden. Abhilfe: Setzen Sie die
     Schriftarten-Platzhalter außerhalb des (!idx ...)-Befehls.

 Bilder & emTeX: Die Ausgabe von MSP- und PCX-Bitmaps mittels emTeX
     ist noch ziemlich neu und ziemlich ungetestet. Erste Tests
     verliefen bei mir erfolgreich. Falls die Ausgabe bei Ihnen nicht
     funktionieren sollte, so verwenden Sie das Kommando
     !no_images [win] und sorgen Sie mit der raw-Umgebung bitte
     selber für die nötige Einbindung der Bilder.

 Kleine Fehler bei der Formatierung in WinHelp: Wenn viele Kapitel
     benutzt werden und die Kapitelnummern "breit" werden, kann es zu
     falschen Einrückungen in den Inhaltsverzeichnissen kommen.
     Benutzen Sie dann den Schalter !no_numbers [win].

 Tilden bei !node, !alias und !label: Hier gibt es Querbeet noch
     Probleme. Bitte verzichten Sie auf Tilden bei diesen Befehlen.

 Kopfzeilen bei HTML: Werden Kapitel zusammengefaßt, so stimmen
     manchmal die Links, die sich hinter den Pfeilen befinden, nicht
     mehr.


Falls Sie einen weiteren Fehler entdeckt haben sollte, so melden Sie
ihn mir (siehe "Dirk Hagedorn") bitte.

Die Angabe eines kurzen Beispiels, in dem der Fehler nachvollzogen
werden kann, ist in diesem Fall sehr von Vorteil. Geben Sie an, was
UDO Ihrer Meinung nach falsch macht und wie es eigentlich aussehen
sollte. Dies ermöglicht es mir, den Fehler schneller nachvollziehen
zu können und zu beseitigen. Auch sollten Sie nicht vergessen, die
Konfiguration Ihres Rechners anzugeben.

Bitte glauben Sie es mir, daß ich mit Aussagen wie "Bei mir erzeugt
UDO für X nur Müll", "Warum läuft bei mir die X-Version nicht?" oder
"Warum erzeugt UDO das so und nicht anders?" nichts anfangen kann.



Anhang C

Fehlermeldungen
***************

UDO protokolliert in einem Logfile, welches die Endung ".ul?"
besitzt, Fehler, die bei der Umwandlung aufgetreten sind. Die
folgenden Abschnitte zeigen, was sich hinter diesen Fehlermeldungen
verbirgt.


C.1  Fehlermeldungen des Programms
==================================

 couldn't open hypfile: UDO kann die angegebene Datei nicht öffnen.
     Überprüfen Sie den Dateinamen oder entfernen Sie den Schreib-
     schutz der Datei, falls Sie bereits existiert.

 couldn't open logfile: UDO kann die angegebene Datei nicht öffnen.
     Überprüfen Sie den Dateinamen oder entfernen Sie den Schreib-
     schutz der Datei, falls Sie bereits existiert.

 couldn't open destinationfile: UDO kann die angegebene Datei nicht
     öffnen. Überprüfen Sie den Dateinamen oder entfernen Sie den
     Schreibschutz der Datei, falls Sie bereits existiert.

 couldn't open source file: Die Quelldatei konnte nicht geöffnet
     werden. Entweder ist diese nicht vorhanden oder der Zugriff auf
     diese Datei ist zur Zeit nicht möglich.

 couldn't open treefile: UDO kann die Datei, in dem die Benutzung von
     Quelldateien innerhalb der Dokumentation angezeigt werden soll,
     nicht anlegen.

 couldn't read BMP header: Die Datei, die bei !image bzw. angegeben
     wurde, konnte nicht geöffnet werden oder es handelt sich bei
     dieser Datei nicht um eine Windows-Bitmap.

 couldn't read IMG header: Die Datei, die bei !image angegeben wurde,
     konnte nicht geöffnet werden oder es handelt sich bei dieser
     Datei nicht um ein GEM-Image.

 couldn't read MSP header: Die Datei, die bei !image angegeben wurde,
     konnte nicht geöffnet werden oder es handelt sich bei dieser
     Datei nicht um eine Grafik im MSP-Format. Falls Sie PCXe mit
     emTeX benutzen, ignorieren Sie bitte diese Fehlermeldung.

 couldn't read PCX header: Die Datei, die bei !image angegeben wurde,
     konnte nicht geöffnet werden oder es handelt sich bei dieser
     Datei nicht um eine Grafik im PCX-Format.

 couldn't write IMG header: Die Datei, die bei !image angegeben
     wurde, konnte nicht geöffnet werden oder ist schreibgeschützt.

 couldn't open <file> pass 1: UDO konnte die Datei namens <file> im
     ersten Durchgang nicht öffnen. Überprüfen Sie bitte den
     Dateinamen.

 couldn't open <file> pass 2: UDO konnte die Datei namens <file> im
     zweiten Durchgang nicht öffnen. Überprüfen Sie bitte den
     Dateinamen.

 memory allocation failed: UDO kann den für eine Operation nötigen
     Speicherplatz nicht anfordern. Das Programm wird nicht
     unterbrochen.


C.2  Meldungen aufgrund Syntaxfehlern
=====================================

Fehlermeldungen, die während der Umwandlung der Quelldatei ausgegeben
werden, enthalten immer folgenden Aufbau:

    ! <datei> <zeilennummer>: <text>

Zur Beseitigung dieser Fehlermeldung schauen Sie sich in der ange-
gebenen Datei die betroffene Zeile an und versuchen Sie, den ange-
geben Fehler zu lokalisieren und zu korrigieren. Beginnen Sie dabei
mit der Korrektur des ersten Fehlers und wandeln Sie die Quelldatei
neu um. Manche Fehlermeldungen sind auf vorangegangene Fehler
zurückzuführen.

 `...' expected: UDO erwartet das angegebene Kommando. Überprüfen Sie
     die Stelle des Quelltextes und fügen Sie das in der
     Fehlermeldung angegebene Kommando ein.

 `...' ignored outside preambel: Es wurde ein Befehl außerhalb des
     Vorspanns, also nach !begin_document benutzt, obwohl dieser
     Befehl dann nicht mehr erlaubt ist. Entfernen Sie den Befehl aus
     dem Hauptteil bzw. verschieben Sie ihn in den Vorspann.

 `...' inside preambel may cause trouble: Es wurde ein Befehl inner-
     halb des Vorspanns, also vor !begin_document benutzt, obwohl
     dieser Befehl dort noch nicht erlaubt ist. Der fehlerhafte Ein-
     satz wird von UDO zwar erkannt, jedoch nicht ignoriert. Dadurch
     können Probleme auftreten. Entfernen Sie die beanstandete
     Passage aus den Vorspann.

 `...' not active: Sie wollten einen der Texteffekte ausschalten bzw.
     das Ende einer Fußnote markieren, obwohl der Texteffekt noch
     nicht eingeschaltet bzw. der Anfang einer Fußnote noch nicht
     markiert wurde.

 `...' still active: Sie wollten einen der Texteffekte einschalten
     bzw. den Beginn einer Fußnote markieren, obwohl dies bereits
     zuvor geschehen ist.

 `...' not available in this charset: Sie benutzen in einem Quelltext
     ein Zeichen, welches in dem Zeichensatz, der vom Zielformat
     benutzt wird, nicht vorhanden ist.

 couldn't replace (!*link ...): Der Querverweis konnte nicht angelegt
     werden. Dieses Problem tritt auf, wenn in einem Absatz zuviele
     Querverweise oder Bilder benutzt werden. Versuchen Sie, den
     einen Absatz in mehrere Absätze aufzuteilen.

 couldn't replace (!img ...): Schauen Sie sich die vorherige
     Erklärung an.

 `!else' without `!if...': Es wurde !else benutzt, ohne daß mit
     !ifdest bzw. !iflang eine spezielle Umgebung begonnen wurde.

 empty !define: Beim Befehl !define haben Sie zuwenige bzw. gar keine
     Parameter angegeben. Der Befehl wird daher ignoriert.

 empty !hyphen: Beim Befehl !hyphen haben Sie zuwenige bzw. gar keine
     Parameter angegeben. Der Befehl wird daher ignoriert.

 empty !macro: Beim Befehl !macro haben Sie zuwenige bzw. gar keine
     Parameter angegeben. Der Befehl wird daher ignoriert.

 `!endif' without `!if...': Eine spezielle Umgebung sollte beendet
     werden, ohne daß sie mit !ifdest bzw. !iflang begonnen wurde.

 `!end_...' without `!begin_...': Eine Umgebung soll beendet werden,
     obwohl die betroffene Umgebung noch nicht begonnen wurde.

 `!item' outside environment: UDO trifft auf einen Aufzählungspunkt,
     ohne daß eine itemize-, enumerate-, description- oder xlist-
     Umgebung begonnen wurde.

 link destination possibly undefined: Bei einem Querverweis ist das
     Sprungziel mit großer Wahrscheinlichkeit nicht vorhanden.
     Überprüfen Sie, ob sie dem Sprungziel nicht einen anderen Namen
     zugewiesen haben.

 missing parameter(s) at `...': Sie haben bei einem Kommando keine
     oder zuwenige Parameter angegeben.

 odd number off "": Die Quelldateien enthalten eine ungerade Anzahl
     an doppelten Anführungszeichen.

 odd number off '': Die Quelldateien enthalten eine ungerade Anzahl
     an doppelten Apostrophen.

 paragraph with short line: In der Ausgabedatei taucht im angegebenen
     Absatz eine Zeile auf, die zu kurz ist und dadurch einen unak-
     zeptablen rechten Flatterrand erzeugt. In der Fehlermeldung wird
     außerdem ein Wort ausgegeben, welches nicht mehr in die kurze
     Zeile paßte und mit ziemlicher Sicherheit die Ursache für die
     Kürze der Zeile ist. Versuchen Sie, in diesem Wort einen Trenn-
     vorschlag einzufügen.

 too many columns used:

     Die maximale Spaltenzahl einer Tabelle wurde überschritten.

 too many defines defined: Im Quelltext wurden zuviele Definitionen
     benutzt.

 too many environments used: Sie haben die maximale Verschachtel-
     ungstiefe der Umgebungen überschritten. Versuchen Sie, den
     Quelltext so anzuordnen, daß solch tiefe Verschachtelungen
     nicht benötigt werden.

 too many defines defined: Im Quelltext wurden zuviele Definitionen
     benutzt.

 too many hyphens defined: Im Quelltext wurden zuviele !hyphen's
     definiert. Entfernen Sie selten benutzte Trennvorschläge und
     geben Sie die Trennstellen in den betroffenen Worten direkt an.

 too many macros defined: Im Quelltext wurden zuviele Makros
     definiert. Versuchen Sie die unwichtigsten Makros zu entfernen
     bzw. im Text direkt anzugeben.

 too many rows used:

     Die maximale Zeilenanzahl einer Tabelle wurde überschritten.

 too many columns used:

     Die maximale Spaltenzahl einer Tabelle wurde überschritten.

 unexpected end of line in command: Ein Kommando, welches komplett in
     einer Zeile untergebracht werden muß, ist über mehrere Zeilen
     verteilt bzw. die Kommandobegrenzung wurde nicht richtig
     angegeben.

 unknown command: Das angegebene Kommando kennt UDO nicht. Für den
     ungewöhnlichen Fall, daß Sie ein Wort benutzen möchten, daß mit
     einem Ausrufezeichen beginnt, müssen Sie dieses Wort durch Ein-
     fügen eines Schrägstrichs "quoten" (Beispiel: !/wort).

 wrong number of parameters: Sie haben bei einem Kommando zuviele
     oder zuwenige Parameter übergeben.



Anhang D

Dies & das
**********


D.1  Zahlen und Fakten
======================

Folgende Maximalwerte müssen Sie beim Erstellen der Quelltexte
beachten:


             +-----------------------------------+------+
             | !macro's                          |   64 |
             | !define's                         |   64 |
             | !hyphen's                         |  512 |
             +-----------------------------------+------+
             | Kapitel                           | 1024 |
             | Labels                            | 1024 |
             +-----------------------------------+------+
             | Zeichen pro Zeile                 |  512 |
             | Zeichen pro Wort                  |  128 |
             | Silben pro Wort                   |   32 |
             | Worte pro Absatz                  |  800 |
             | Querverweise pro Absatz           |  200 |
             +-----------------------------------+------+
             | Zeilen pro Tabelle                |  128 |
             | Spalten pro Tabelle               |   32 |
             +-----------------------------------+------+
             | Schachtelungstiefe der Umgebungen |    6 |
             +-----------------------------------+------+



Ein paar Zahlen, die demonstrieren, wieviel Arbeit und Zeit in diesem
Programm und der Dokumentation stecken:


       +-----------------------------------------+------------+
       | Art                                     | Größe/Zeit |
       +-----------------------------------------+------------+
       | Umfang der Quelltexte                   | ca. 500 KB |
       | Quelltexte der deutschen Dokumentation  | ca. 300 KB |
       | Quelltexte der englischen Dokumentation | ca. 180 KB |
       +-----------------------------------------+------------+



D.2  Entwicklungsumgebung
=========================

UDO wurde unter Zuhilfenahme folgender Programme entwickelt:

 Amiga:     Hier fehlt noch etwas...

 Atari:     Pure-C 1.1, MiNT-Libs PL 46, SysGem 2.03 β, Interface
            2.3, Programming Tools von Julian F. Reschke

 DOS:       EMX-GCC 2.6.3 emxfix06, Joe Allan's Own Editor `Joe' für
            MS-DOS

 HP-UX:     GCC 2.7.2

 Linux:     GCC 2.6.3

 Macintosh: Hier fehlt noch etwas...

Momentan findet die Entwicklung von UDO fast ausschließlich auf
meinem kleinen Compaq Contura Notebook statt (das geht, echt!). Die
Sourcecodes werden mit Joe geschrieben. Die Erzeugung aller anderen
Versionen erfolgt durch Kopieren der Sourcecodes und einem "Make
All". Mehr gibt es nicht zu tun.



Diese Dokumentation wurde unter Zuhilfenahme folgender Programme
geschrieben:

   ∙ Joe Allan's Own Editor `Joe' für MS-DOS
   ∙ Allan Phillips' Programmer's File Editor `PFE' 0.06.01
   ∙ Phoenix für Windows von Application Systems Heidelberg
   ∙ Everest von Oliver Schmidt

Alle Programme kann ich dem geneigten DOS-, Windows- und Atari-
Benutzer nur wärmstens empfehlen!


D.3  Erzeugte Dateien
=====================

Es folgt eine Auflistung der Endungen der Dateien, die Ihnen beim
Umgang mit UDO über den Weg laufen werden.

 .asc: ASCII-Format
 .1:   Manualpage-Format
 .cmd: Kommandodatei für den Pure-C-Help-Hypertext-Compiler
 .hpj: Projektdatei für den WinHelp-Hypertext-Compiler HC.EXE
 .htm: HTML-Format
 .rtf: RTF bzw. WinHelp-Quelltext
 .scr: Pure-C-Help-Quelltext
 .stg: ST-Guide-Quelltext
 .txt: Turbo-Vision-Help-Quelltext
 .tex: LaTeX- bzw. Texinfo-Quelltext
 .uha: Hyphenation-Datei mit Trennvorschlägen für das ASCII-Format
 .uhp: dito für Pure-C-Help
 .uhs: dito für ST-Guide
 .uh1: dito für Manualpage
 .ula: Logfile der ASCII-Umwandlung
 .ulh: Logfile der HTML-Umwandlung
 .uli: Logfile der Texinfo-Umwandlung
 .ulp: Logfile der Pure-C-Help-Umwandlung
 .ulr: Logfile der RTF-Umwandlung
 .uls: Logfile der ST-Guide-Umwandlung
 .ult: Logfile der TeX-Umwandlung
 .ulv: Logfile der Turbo-Vision-Help-Umwandlung
 .ulw: Logfile der WinHelp-Umwandlung
 .ul1: Logfile der Manualpage-Umwandlung
 .uta: Includebaum der ASCII-Umwandlung
 .uth: Includebaum der HTML-Umwandlung
 .uti: Includebaum der Texinfo-Umwandlung
 .utp: Includebaum der Pure-C-Help-Umwandlung
 .utr: Includebaum der RTF-Umwandlung
 .uts: Includebaum der ST-Guide-Umwandlung
 .utt: Includebaum der TeX-Umwandlung
 .utv: Includebaum der Turbo-Vision-Help-Umwandlung
 .utw: Includebaum der WinHelp-Umwandlung
 .ut1: Includebaum der Manualpage-Umwandlung

Die folgenden Dateiendungen werden auftauchen, wenn Sie die von UDO
erzeugten Dateien durch die formatzugehörigen Programmen (siehe
Klammerinhalt) weiterbearbeiten:

 .err: Logfile des WinHelp-Compilers (HC.EXE)
 .h:   C-Header-File für Turbo-Vision (TVHC.EXE)
 .hlp: WinHelp-Datei (HC.EXE), Turbo-Vision-Help-Datei (TVHC.EXE),
       Pure-C-Help-Datei (HC.PRG)
 .hyp: ST-Guide-Hypertext (HCP.TTP)
 .ref: ST-Guide-Referenzdatei (HCP.TTP)



Anhang E

Historie
********

An dieser Stelle findet man eine kurze Beschreibung der Änderungen,
die zwischen den einzelnen Versionen von UDO aufgetreten sind.


E.1  In letzter Minute
======================

Hier finden Sie Änderungen, die noch in letzter Minute eingetreten
sind und noch nicht im restlichen Teil vermerkt sein können.


   ∙ Ich habe die Tabellen zur Umwandlung der verschiedenen
     Zeichensätze völlig neu programmiert. Es kann sein, daß dadurch
     neue Fehler unbeabsichtigt eingebaut wurden.

   ∙ Ein neuer Schalter gestattet es, im Text vordefinierte
     Platzhalter für 8-Bit-Zeichen zu verwenden, um den systemweiten
     Austausch von Quelltexten zu vereinfachen. Dieser Schalter
     lautet !universal_charset [ on | off ].

     Nach dem Einschalten des "universellen Zeichensatzes" stehen
     einem folgende Platzhalter (PH) zur Verfügung:


             +-------+----------------+-----------------+
             | PH    | x aus          | Beispiel        |
             | (!"x) | aeiosuyAEIOU   | (!"a) = ä   |
             | (!'x) | aeiouyAEIOUY   | (!'e) = é   |
             | (!`x) | aeiouAEIOU     | (!`i) = ì   |
             | (!^x) | aeiouAEIOU     | (!^o) = ô   |
             | (!&x) | ae, oe, AE, OE | (!&AE) = Æ |
             | (! x) | anoANO         | (! n) = (~n)    |
             | (!,x) | cC             | (!,C) = Ç   |
             | (!.x) | aA             | (!.A) = Å   |
             | (!_x) | ao             | (!_a) = ª   |
             | (!\x) | oO             | (!\O) = O   |
             +-------+----------------+-----------------+


     Das deutsche `ß' wird durch den Platzhalter (!"s) erzeugt.

     Kennt das Zielformat ein Zeichen nicht, so wird das
     naheliegendste Zeichen benutzt, z.B. `a' statt `â'.

     Bald wird man hier auch andere Zeichen angeben können.


E.2  Release 5
==============

Hier eine kleine Übersicht der wichtigsten Änderungen zur letzten
öffentlichen Version. In den vier Monaten wurden etliche neue
Features eingebaut und einige Fehlerbeseitigungen vorgenommen. Auch
hier hat es in der Zwischenzeit wieder nicht vermeiden lassen, die
Syntax einiger Befehle zu ändern.

Registrierte Benutzer, die sich die Zwischenversionen beschafft
haben, finden hier als Gedächtnisstütze meine komprimierten
Anmerkungen aus changes.asc.

 Neue Formate:
        ∙ Linuxdoc-SGML
        ∙ Turbo Vision Help
        ∙ Texinfo
 Neue Befehle:
        ∙ !alias
        ∙ !begin_raw, !end_raw
          ermöglich die Angabe größerer Blöcke Spezialbefehle für ein
          Format
        ∙ !begin_table, !end_table
          Tabellensatz, latexlike!
        ∙ !chapterimage
          einem Kapitel ein Titelbild zuweisen
        ∙ !define
        ∙ !french
          französische Bezeichnungen verwenden
        ∙ !heading, !subheading, !subsubheading
          Erzeugung von Überschriften im Text
        ∙ !hline
          Ausgabe horizontaler Linien
        ∙ !htmlname
          einem Kapitel einen Dateinamen zuweisen
        ∙ !html_merge_nodes, !html_merge_subnodes,
          !html_merge_subsubnodes
          Kapitel für die HTML-Ausgabe zusammenfassen
        ∙ (!ilink ...)
          Bilder im Text für Querverweise benutzen, nur WinHelp und
          HTML
        ∙ (!img ...)
          Darstellung von Bildern im Text, nur WinHelp und HTML
        ∙ !index
          Indexeintrag setzen
        ∙ !list_parsep
          Ausgabe von Leerzeilen in Umgebungen aus- und einschalten
        ∙ !ifdest, !else, !endif
          für formatabhänige Textpassagen, flexibler als die alten
          Befehle für bedingte Texte (!begin_stg, !else_stg,
          !end_stg)
        ∙ !iflang, !else, !endif
          für sprachabhängige Textpassagen
        ∙ !node*, !subnode*, !subsubnode*, !pnode*, !psubnode*,
          !psubsubnode*
          Kapitel ohne Eintragung ins Inhaltsverzeichnung erzeugen
        ∙ !rinclude
          Spezialbefehle nachladen
        ∙ !use_about_udo
        ∙ !use_chapter_images
          Bilder statt Kapitelüberschiften benutzen, nur für ST-
          Guide, WinHelp und HTML
        ∙ !use_style_book
        ∙ !win_html_look
          WinHelp-Files im HTML-Look mit grauem Hintergrund ausgeben
 Änderungen:
        ∙ Ein Tabellensatz wurde implementiert. Tabellen können nun
          sehr einfach erstellt werden. Dabei kann man frei
          festlegen, wie Spalten ausgerichtet werden sollen und wo
          Linien gezeichnet werden sollen.
        ∙ Die Formatierung der Umgebungen wurde komplett neu
          programmiert. Dadurch ist eine bis zu sechsfache Ver-
          schachtelung (auch der xlist-Umgebung) möglich. Die Ausgabe
          aller Umgebungen funktioniert nun auch bei WinHelp und RTF.
        ∙ Die halbautomatische Silbentrennung wurde komplett neu
          programmiert.
        ∙ Die automatische Referenzierung wurde dahingehend
          verändert, daß ein Verweis nur noch bei ganzen Worten
          angelegt wird.
        ∙ Die maximale Anzahl der Kapitel und Labels innerhalb eines
          Quelltextes wurde verdoppelt. Nun sind maximal 1024
          Kapitel und 1024 Labels möglich.
        ∙ Pro Absatz sind jetzt bis zu 200 Verweise möglich. Früher
          waren (aufgrund eines Fehlers) nur 16 Verweise pro Quell-
          text möglich.
        ∙ Manualpages werden komplett neu formatiert. Nun muß man
          sich nicht mehr die Finger mit description- und quote-
          Umgebungen verbiegen.
        ∙ Für emTeX werden nun auch PCX-Bilder unterstützt.
        ∙ Die WinHelp-Ausgabe wurde drastisch erweitert, so z.B.
          werden Buttons im WinHelp-Fenster angelegt, Labels werden
          direkt angesprungen, etc.
        ∙ Die Atari-Versionen wurden mit den MiNT-Libs PL 46
          erstellt. Die Probleme mit langen Dateinamen dürften daher
          der Vergangenheit angehören.
 Syntaxänderungen:
        ∙ Die speziellen Umgebungen, die mit !begin_*, !else_* und
          !end_* gebildet wurden, müssen nun durch die wesentlich
          flexibleren Kommandos !ifdest, !else und !endif erstellt
          werden.
          Statt...
              !begin_asc
              [...]
              !else_asc
              [...]
              !end_asc

          ... muß man nun folgendes Konstrukt verwenden:
              !ifdest [asc]
              [...]
              !else
              [...]
              !endif

 Bugfixes:
     Etliche. ;-)


E.3  Release 4
==============

Diese Version wurde am 12.11.1995 veröffentlicht.

Gegenüber Release 3 hat sich soviel getan, daß ich jedem nur
empfehlen kann, diese Dokumentation einmal zu überfliegen. Würde ich
alle Änderungen hier angeben, wäre diese Dokumentation um 10 Seiten
länger!

Wer bereits Texte mit UDO3 erstellt hat und sich als registrierter
Benutzer nicht die aktuellen Betaversionen besorgt hat, dem rate ich,
einfach einmal diese Texte mit der neuen Version zu übersetzen,
Fehlermeldungen zu beachten und die Zieldatei unter die Lupe zu
nehmen.

Es müssen nicht viele Anpassungen vorgenommen werden, und die meisten
Anpassungen lassen sich durch einfaches Suchen und Ersetzen mit einem
Editor schnell erledigen. Aber die Syntax von UDO4 ist teilweise
inkompatibel zur Syntax von UDO3!

Hier nun nur die wichtigsten Änderungen:

 Syntaxänderungen und -erweiterungen:

       1. Sonderzeichen müssen nicht mehr besonders gekennzeichnet
          werden, da UDO selber für die nötigen Anpassungen sorgt.

       2. Makros werden anders behandelt.

       3. Viele Spezialbefehle wurden durch allgemeinere Befehle
          ersetzt.

       4. Manche Befehle dürfen nun nur noch im Vorspann, manche nur
          noch im Hauptteil benutzt werden.

 TeX:

       1. Die Titelseite wird nun anders erzeugt.

       2. Trennvorschläge, die mit !hyphen angelegt werden, werden
          nun auch hier beachtet.

       3. Für das CS-TeX wird nun auch das Lindner-TeX-Makro zur
          Ausgabe von GEM-Images benutzt.

       4. Neuer Spezialbefehl !tex_book.

 ST-Guide:

       1. !stg_short_title existiert nicht mehr

 WinHelp, HTML, Manualpage:   Diese Ausgabeformate sind neu
     hinzugekommen.

 1stWordplus:   Dieses Ausgabeformat wird nicht mehr angeboten.


E.4  Release 3
==============

Was sich damals geändert hat, das dürfte heute niemanden mehr
interessieren.



Anhang F

Befehlsindex
************

In diesem Anhang finden Sie eine Kurzbeschreibung aller UDO-Kommandos
in alphabetischer Reihenfolge. Bei jedem Befehl werden folgende
Punkte angezeigt:

 Typ & Position:
     Der Typ des Befehls und die Position, wo der Befehl benutzt
     werden darf.

     Ein Kommando veranlaßt UDO, etwas bestimmtes zu tun, ein
     Schalter setzt bestimmte Informationen, an denen UDO erkennt,
     wie es demnächst zu verfahren hat, ein Platzhalter wird bei der
     Umwandlung lediglich durch etwas anderes ersetzt.

     Bei "Vorspann" darf man einen Befehl nur im Vorspann des Quell-
     textes (also vor !begin_document) einsetzen, bei "Hauptteil"
     darf man einen Befehl nur im Hauptteil des Quelltextes (also
     nach !begin_document) einsetzen, bei "Vorspann & Hauptteil" darf
     man einen Befehl überall einsetzen.

 Syntax:
     Hier sieht man, wie man den Befehl einsetzen muß. "<text>" steht
     für eine Zeichenfolge, "<datei>" steht für einen Dateinamen,
     "<wert>" steht für eine Ziffernfolge, "<zeichen>" steht für ein
     einzelnes Zeichen, "<kürzel>" steht für die Angabe von Kürzeln
     der Ausgabeformate (asc=ASCII, html=HTML, info=Texinfo,
     ldoc=Linuxdoc-SGML, man=Manualpage, pch=Pure-C-Help, rtf=RTF,
     stg=ST-Guide, tex=LaTeX, tvh=Turbo-Vision-Help, win=WinHelp)

 Beispiel:
     Hier findet man eventuell ein Einsatzbeispiel.

 Siehe auch:
     Hier sind verwandte Befehle oder Befehle ausgelistet, die in
     direktem Zusammenhang mit dem beschriebenen Befehl stehen.


F.1  A...
=========


F.1.1  !=asc
------------

Zeile nicht beim ASCII-Format ausgeben.

 Typ & Position: Kommando, Vorspann & Hauptteil

 Syntax:         !=asc <text>

 Beschreibung:   <text> wird nur dann ausgegeben, wenn die Quelldatei
                 nicht ins ASCII-Format umgewandelt wird. <text> wird
                 dann 1:1 und ohne Berücksichtigung etwaiger UDO-
                 Kommandos ausgegeben. Diese Zeile zerteilt Absätze
                 genau wie alle anderen Kommandos.

 Siehe auch:     !asc, !ifdest, Formatspezifisches, raw-Umgebung


F.1.2  !alias
-------------

Zusatznamen eines Kapitels definieren

 Typ & Position: Kommando, Hauptteil

 Syntax:         !alias <text>

 Beschreibung:   Definiert einen Zweitnamen eines Kapitels. Taucht
                 "<text>" im Text auf, wird genauso zum Kapitel
                 referenziert wie bei !label, !node, !subnode,
                 !subsubnode etc. Sie können !alias mehrfach
                 innerhalb eines Kapitels benutzen, jedoch sollte
                 "<text>" nur einmal als Name für einen Alias, Label
                 oder ein Kapitel verwendet werden.

 Siehe auch:     !node, !subnode, !subsubnode, !label


F.1.3  !asc
-----------

Zeile nur beim ASCII-Format ausgeben.

 Typ & Position: Kommando, Vorspann & Hauptteil

 Syntax:         !asc <text>

 Beschreibung:   <text> wird nur dann ausgegeben, wenn die Quelldatei
                 ins ASCII-Format umgewandelt wird. <text> wird dann
                 1:1 und ohne Berücksichtigung etwaiger UDO-Kommandos
                 ausgegeben. Diese Zeile zerteilt Absätze genau wie
                 alle anderen Kommandos.

 Siehe auch:     !=asc, !ifdest, Formatspezifisches, raw-Umgebung


F.1.4  !author
--------------

Namen des Autors setzen.

 Typ & Position: Kommando, Vorspann

 Syntax:         !author <text>

 Beschreibung:   "<text>" wird als Name des Autors auf der Titelseite
                 ausgegeben. Ansonsten findet "<text>" keine weitere
                 Verwendung.

 Beispiel:       !author Dirk Hagedorn

 Siehe auch:     !maketitle, Titelseite


F.1.5  !authorimage
-------------------

 Typ & Position: Kommando, Vorspann

 Syntax:         !authorimage <datei>

 Beschreibung:   "<datei>" wird als Bild (z.B. ein Logo) zusätzlich
                 über dem Namen des Autors auf der Titelseite
                 ausgegeben, falls das Ausgabeformat Unterstützung
                 für Bilder bietet.

 Beispiel:       !authorimage dh

 Siehe auch:     !maketitle, !author, Titelseite, Bilder


F.1.6  !autoref
---------------

Automatische Referenzierung ein-/ausschalten.

 Typ & Position: Schalter, Hauptteil

 Syntax:         !autoref [ on | off ]

 Beschreibung:   Schaltet die automatische Referenzierung ein ([on])
                 oder aus ([off]. Für den ST-Guide wird entsprechend
                 @autorefon bzw. @autorefoff ausgegeben.

 Beispiel:       !autoref [off]


F.1.7  (!alpha)
---------------

 Typ & Position: Platzhalter, Vorspann & Hauptteil

 Syntax:         (!alpha)

 Beschreibung:   Dieser Platzhalter wird durch α ersetzt.

 Siehe auch:     (!beta), Sonderzeichen


F.2  B...
=========


F.2.1  !begin_appendix
----------------------

Anhang einleiten

 Typ & Position: Kommando, Hauptteil

 Syntax:         !begin_appendix

 Beschreibung:   Leitet den Anhang ein. Kapitel werden im Anhang mit
                 Buchstaben gekennzeichnet.

 Siehe auch:     !end_appendix, Anhang


F.2.2  !begin_description
-------------------------

Neue Description-Umgebung starten

 Typ & Position: Kommando, Hauptteil

 Syntax:         !begin_description

 Beschreibung:   Leitet eine (weitere) description-Umgebung ein.
                 Diese Umgebung muß mit !end_description beendet
                 werden. Die description-Umgebung kann mehrfach
                 verschachtelt benutzt werden, auch mit anderen
                 Umgebungen.

 Siehe auch:     !end_description, !item [<text>], Beschreibende
                 Aufzählungen


F.2.3  !begin_document
----------------------

Hauptteil des Dokumentes einleiten

 Typ & Position: Kommando, Hauptteil

 Syntax:         !begin_document

 Beschreibung:   Dieses Kommando muß in jedem Quelltext vorhanden
                 sein. Es leitet den Hauptteil ein.

 Siehe auch:     !end_document


F.2.4  !begin_enumerate
-----------------------

Neue enumerate-Umgebung einleiten

 Typ & Position: Kommando, Hauptteil

 Syntax:         !begin_enumerate

 Beschreibung:   Leitet eine (weitere) enumerate-Umgebung ein. Diese
                 Umgebung muß mit !end_enumerate beendet werden. Die
                 enumerate-Umgebung können Sie mehrfach verschachtelt
                 benutzen.

 Siehe auch:     !end_enumerate, !item, Numerierte Aufzählungen


F.2.5  !begin_itemize
---------------------

Neue itemize-Umgebung einleiten

 Typ & Position: Kommando, Hauptteil

 Syntax:         !begin_itemize

 Beschreibung:   Leitet eine (weitere) itemize-Umgebung ein. Diese
                 Umgebung muß mit !end_itemize beendet werden. Die
                 itemize-Umgebung können Sie mehrfach verschachtelt
                 benutzen.

 Siehe auch:     !end_itemize, !item, Einfache Aufzählungen


F.2.6  !begin_quote
-------------------

Umgebungstext eingerückt darstellen.

 Typ & Position: Kommando, Hauptteil

 Syntax:         !begin_quote

 Beschreibung:   Dieses Kommando leitet eine (weitere) quote-Umgebung
                 ein. Text, der zwischen diesem und !end_quote
                 angegeben ist, wird eingerückt dargestellt.

 Siehe auch:     !end_quote, Einrücken von Absätzen


F.2.7  !begin_raw
-----------------

Neue raw-Umgebung einleiten

 Typ & Position: Kommando, Vorspann & Hauptteil

 Syntax:         !begin_raw

 Beschreibung:   Leitet eine raw-Umgebung ein. Diese Umgebung muß mit
                 !end_raw beendet werden. Jede Zeile innerhalb dieser
                 Umgebung wird direkt, also ohne jegliche Umwandlung,
                 Zentrierung oder Einrückung ausgegeben.

 Siehe auch:     !end_raw, raw-Umgebung, !rinclude


F.2.8  !begin_table
-------------------

Eine Tabelle beginnen

 Typ & Position: Kommando, Hauptteil

 Syntax:         !begin_table [<format>] {!hline}

 Beschreibung:   Mit diesem Kommando wird eine Tabelle eingeleitet.
                 Für `<format>' geben Sie an, wie die Spaten der
                 Tabelle ausgerichtet werden sollen und vor bzw. nach
                 welcher Spalte vertikale Linien gezogen werden
                 sollen. Wird zum Schluß noch `!hline' angegeben, so
                 beginnt die Tabelle mit einer horizontalen Linie. Im
                 Beispiel sehen Sie eine Tabelle, die mit links,
                 rechts und oben mit einer Linie versehen ist und die
                 Spalten linksbündig, zentriert und rechtsbündig
                 ausgerichtet werden.

 Beispiel:       !begin_table [|lcr|] !hline

 Siehe auch:     Tabellen


F.2.9  !begin_verbatim
----------------------

Eine verbatim-Umgebung einleiten

 Typ & Position: Kommando, Hauptteil

 Syntax:         !begin_verbatim

 Beschreibung:   Leitet eine verbatim-Umgebung ein. Diese Umgebung
                 muß mit !end_verbatim beendet werden. Text einer
                 verbatim-Umgebung wird 1:1 ausgegeben, es werden
                 keine UDO-Kommandos umgewandelt! Einrückungen werden
                 beachtet.

 Siehe auch:     !end_verbatim, Vorformatierter Text, !vinclude


F.2.10  !begin_xlist
--------------------

Eine Liste einleiten

 Typ & Position: Kommando, Hauptteil

 Syntax:         !begin_xlist [<text>]

 Beschreibung:   Leitet eine neue Listen-Umgebung ein. Diese Umgebung
                 muß mit !end_xlist beendet werden. Die Länge von
                 "<text>" definiert die Tiefe der Einrückung der
                 Aufzählungspunkte. Diese Umgebung läßt sich mit
                 anderen Umgebungen verschachtelt benutzen.

 Siehe auch:     !end_xlist, !item [<text>], Listen


F.2.11  !bigskip
----------------

Drei zusätzliche Leerzeilen einfügen

 Typ & Position: Kommando, Hauptteil

 Syntax:         !bigskip

 Beschreibung:   Wird bei der Ausgabe ins LaTeX-Format durch
                 "\bigskip" ersetzt. Ansonsten werden drei
                 zusätzliche Leerzeilen ausgegeben.

 Siehe auch:     !smallskip, !medskip


F.2.12  !break
--------------

Umwandlung vorzeitig unterbrechen

 Typ & Position: Kommando, Hauptteil

 Syntax:         !break

 Beschreibung:   Dieses Kommando kann man benutzen, um die Umwandlung
                 des Quelltextes vorzeitig zu beenden. Alles, was
                 nach "!break" folgt, wird nicht mehr beachtet. UDO
                 führt noch automatisch ein !end_appendix und
                 !end_document aus, bevor die Umwandlung unterbrochen
                 wird.


F.2.13  (!B)...(!b)
-------------------

Fettschrift

 Typ & Position: Platzhalter, Vorspann & Hauptteil

 Syntax:         (!B)<text>(!b)

 Beschreibung:   "<text>" wird fett dargestellt, falls möglich.

 Beispiel:       (!B)fett(!b)

 Siehe auch:     Texthervorhebungen


F.2.14  (!beta)
---------------

 Typ & Position: Platzhalter, Vorspann & Hauptteil

 Syntax:         (!beta)

 Beschreibung:   Dieser Platzhalter wird durch β ersetzt.

 Siehe auch:     (!alpha), Sonderzeichen


F.3  C...
=========


F.3.1  !chapterimage
--------------------

Kapitelüberschrift durch Grafik ersetzen

 Typ & Position: Kommando, Hauptteil

 Syntax:         !chapterimage <datei>

 Beschreibung:   Beim HTML-, ST-Guide- und WinHelp-Format wird
                 anstelle einer Kapitelüberschrift die Grafik
                 "<datei>" verwendet, falls im Vorspann der Schalter
                 !use_chapter_images verwendet wurde.

 Beispiel:       !chapterimage udo

 Siehe auch:     Bilder, !use_chapter_images


F.3.2  !code_ansi
-----------------

Text im Windows-ANSI-Zeichensatz einlesen.

 Typ & Position: Schalter, Vorspann & Hauptteil

 Syntax:         !code_ansi

 Beschreibung:   UDO erwartet nach diesem Kommando einen ANSI-Zei-
                 chensatz. Mit !code_ascii kann man wieder auf den
                 systemabhängigen ASCII-Zeichensatz zurückschalten.

 Siehe auch:     !code_ascii


F.3.3  !code_ascii
------------------

ASCII-Zeichensatz benutzen

 Typ & Position: Schalter, Vorspann & Hauptteil

 Syntax:         !code_ascii

 Beschreibung:   UDO erwartet nach diesem Kommando den
                 systemabhängigen ASCII-Zeichensatz. Dies ist die
                 Voreinstellung.

 Siehe auch:     !code_ansi


F.4  D...
=========


F.4.1  !date
------------

Datumsinformation für Titelseite setzen

 Typ & Position: Kommando, Vorspann

 Syntax:         !date <text>

 Beschreibung:   "<text>" wird unterhalb der Versionsinformationen
                 auf der Titelseite ausgegeben. Im Beispiel würde auf
                 der Titelseite das aktuelle Systemdatum eingesetzt.

 Beispiel:       !date 8. April 1996

 Siehe auch:     !maketitle, (!today) (!short_today), Titelseite


F.4.2  !define
--------------

Definition setzen

 Typ & Position: Kommando, Vorspann

 Syntax:         !define <wort> <text>

 Beschreibung:   Dieses Kommando definiert eine neue Definition. Bei
                 der Umwandlung wird dann "(!<wort>)" durch "<text>"
                 ersetzt, ohne daß Umlaute oder andere spezielle
                 Zeichen umgewandelt werden. Im Beispiel würde
                 "(!H1)" durch "</H1>" ersetzt.

 Beispiel:       !define H1 </H1>

 Siehe auch:     Definitionen


F.5  E...
=========


F.5.1  !else
------------

 Typ & Position: Kommando, Vorspann & Hauptteil

 Syntax:         !else

 Beschreibung:   Die diesem Kommando folgenden Zeilen werden bis zum
                 Eintreffen von !endif ausgegeben, wenn bei !ifdest
                 oder !iflang nicht das Kürzel des aktuellen Ausga-
                 beformates bzw. der Ausgabesprache angegeben wurde.

 Siehe auch:     !ifdest, !iflang, !endif, Formatspezifisches


F.5.2  !email
-------------

EMail-Informationen für die Titelseite setzen

 Typ & Position: Kommando, Vorspann

 Syntax:         !email <text>

 Beschreibung:   "<text>" wird auf der Titelseite unterhalb des
                 Namens und der Anschrift des Autors ausgegeben.
                 "<text>" findet sonst keine weitere Verwendung durch
                 UDO.

 Beispiel:       !email [e-mail]

 Siehe auch:     !maketitle, Titelseite


F.5.3  !end_appendix
--------------------

Anhang beenden

 Typ & Position: Kommando, Hauptteil

 Syntax:         !end_appendix

 Beschreibung:   Beendet den Anhang.

 Siehe auch:     !begin_appendix, Anhang


F.5.4  !end_description
-----------------------

Letzte description-Umgebung beenden

 Typ & Position: Kommando, Hauptteil

 Syntax:         !end_description

 Beschreibung:   Beendet die letzte description-Umgebung.

 Siehe auch:     !begin_description, !item [<text>], Beschreibende
                 Aufzählungen


F.5.5  !end_document
--------------------

Ende des Dokumentes setzen

 Typ & Position: Kommando, Hauptteil

 Syntax:         !end_document

 Beschreibung:   Dieses Kommando muß in jedem Quelltext vorhanden
                 sein. Es beendet den Hauptteil und sollte das letzte
                 Kommando des Quelltextes sein.

 Siehe auch:     !begin_document


F.5.6  !end_enumerate
---------------------

Letzte numerierte Aufzählung beenden

 Typ & Position: Kommando, Hauptteil

 Syntax:         !end_enumerate

 Beschreibung:   Beendet die letzte enumerate-Umgebung.

 Siehe auch:     !begin_enumerate, !item, Numerierte Aufzählungen


F.5.7  !end_itemize
-------------------

Letzte einfache Aufzählung beenden

 Typ & Position: Kommando, Hauptteil

 Syntax:         !end_itemize

 Beschreibung:   Beendet die letzte itemize-Umgebung.

 Siehe auch:     !begin_itemize, !item, Einfache Aufzählungen


F.5.8  !end_quote
-----------------

Letzte Absatzeinrückung aufheben

 Typ & Position: Kommando, Hauptteil

 Syntax:         !end_quote

 Beschreibung:   Dieses Kommando beendet die letzte quote-Umgebung,
                 in der der Text eingerückt dargestellt wird.

 Siehe auch:     !begin_quote


F.5.9  !end_raw
---------------

Raw-Umgebung beenden

 Typ & Position: Kommando, Vorspann & Hauptteil

 Syntax:         !end_raw

 Beschreibung:   Beendet die raw-Umgebung.

 Siehe auch:     !begin_raw, raw-Umgebung


F.5.10  !end_table
------------------

Tabelle beenden und ausgeben

 Typ & Position: Kommando, Hauptteil

 Syntax:         !end_table

 Beschreibung:   Beendet die table-Umgebung und sorgt für die Ausgabe
                 der Tabelle.

 Siehe auch:     Tabellen, !begin_table


F.5.11  !end_verbatim
---------------------

Verbatim-Umgebung beenden

 Typ & Position: Kommando, Hauptteil

 Syntax:         !end_verbatim

 Beschreibung:   Beendet die verbatim-Umgebung.

 Siehe auch:     !begin_verbatim, Vorformatierter Text


F.5.12  !end_xlist
------------------

Liste beenden

 Typ & Position: Kommando, Hauptteil

 Syntax:         !end_xlist

 Beschreibung:   Beendet die letzte xlist-Umgebung.

 Siehe auch:     !begin_xlist, !item [<text>], Listen


F.5.13  !endif
--------------

Spezielle Umgebung beenden

 Typ & Position: Kommando, Vorspann & Hauptteil

 Syntax:         !endif

 Beschreibung:   Beendet eine spezielle Umgebung, die mit !ifdest
                 oder !iflang begonnen wurde. Der diesem Befehl
                 folgende Text wird wieder für alle Formate
                 ausgegeben.

 Siehe auch:     !ifdest, !iflang, !else


F.5.14  !english
----------------

Englische Begriffe benutzen

 Typ & Position: Schalter, Vorspann

 Syntax:         !english

 Beschreibung:   UDO benutzt in der Ausgabedatei englischsprachige
                 Bezeichnungen, z.B. "Contents" statt "Inhaltsver-
                 zeichnis".

 Siehe auch:     !german, !french, !iflang


F.6  F...
=========


F.6.1  !french
--------------

Französische Begriffe benutzen

 Typ & Position: Schalter, Vorspann

 Syntax:         !french

 Beschreibung:   UDO benutzt französischsprachige Bezeichnungen im
                 Ausgabeformat, wie z.B. "Table des matières"
                 anstatt "Inhaltsverzeichnis".

 Siehe auch:     !german, !english, !iflang


F.6.2  !fussy
-------------

Warnmeldungen vor kurzen Zeilen einschalten

 Typ & Position: Schalter, Hauptteil

 Syntax:         !fussy

 Beschreibung:   Schaltet die Warnung vor kurzen Zeilen wieder ein.
                 Bei der Umwandlung ins LaTeX-Format erfolgt keine
                 Umsetzung in \fussy!

 Siehe auch:     !sloppy, Fehlermeldungen, Silbentrennung


F.6.3  (!F)...(!f)
------------------

Eingerahmter Text

 Typ & Position: Platzhalter, Vorspann & Hauptteil

 Syntax:         (!F)<text>(!f)

 Beschreibung:   "<text>" wird nur in LaTeX innerhalb eines Rechtecks
                 dargestellt. (!F)...(!f) wird hier durch \fbox{...}
                 ersetzt.

 Beispiel:       (!F)Living in a box(!f)

 Siehe auch:     Texthervorhebungen


F.6.4  (!file)
--------------

 Typ & Position: Platzhalter, Vorspann & Hauptteil

 Syntax:         (!file)

 Beschreibung:   Dieser Platzhalter wird bei der Umwandlung durch den
                 Dateinamen ersetzt, in dem sich dieser Platzhalter
                 befindet.

 Beispiel:       Aus (!file) wird


F.7  G...
=========


F.7.1  !german
--------------

Deutsche Begriffe benutzen

 Typ & Position: Schalter, Vorspann

 Syntax:         !german

 Beschreibung:   UDO benutzt deutschsprachige Bezeichnungen im Aus-
                 gabeformat. Dies ist die Voreinstellung.

 Siehe auch:     !english, !french, !iflang


F.7.2  (!G)...(!g)
------------------

Heller Text

 Typ & Position: Platzhalter, Vorspann & Hauptteil

 Syntax:         (!G)<text>(!g)

 Beschreibung:   "<text>" wird hell dargestellt, falls möglich.

 Beispiel:       (!G)hell(!g)

 Siehe auch:     Texthervorhebungen


F.7.3  (!grin)
--------------

Emoticon

 Typ & Position: Platzhalter, Vorspann & Hauptteil

 Syntax:         (!grin)

 Beschreibung:   Dieser Platzhalter wird durch einen grinsenden
                 Smiley ersetzt, der in Schreibmaschinenschrift
                 ausgegeben wird.

 Beispiel:       Aus (!grin) wird ;-)

 Siehe auch:     (!laugh)


F.8  H...
=========


F.8.1  !=html
-------------

Zeile nicht beim HTML-Format ausgeben.

 Typ & Position: Kommando, Vorspann & Hauptteil

 Syntax:         !=html <text>

 Beschreibung:   <text> wird nur dann ausgegeben, wenn die Quelldatei
                 nicht ins HTML-Format umgewandelt wird. <text> wird
                 dann 1:1 und ohne Berücksichtigung etwaiger UDO-
                 Kommandos ausgegeben. Diese Zeile zerteilt Absätze
                 genau wie alle anderen Kommandos.

 Siehe auch:     !html, !ifdest, Formatspezifisches, raw-Umgebung


F.8.2  !hline
-------------

Horizontale Linie ausgeben

 Typ & Position: Kommando, Hauptteil

 Syntax:         !hline

 Beschreibung:   Dieses Kommando fügt in die Zieldatei eine
                 horizontale Linie ein. Desweiteren dient das
                 Kommando dazu, um horizontale Linien innerhalb einer
                 Tabelle zu erzeugen.

 Siehe auch:     Tabellen


F.8.3  !html
------------

Zeile nur für das HTML-Format ausgeben.

 Typ & Position: Kommando, Vorspann & Hauptteil

 Syntax:         !html <text>

 Beschreibung:   <text> wird nur dann ausgegeben, wenn die Quelldatei
                 ins HTML-Format umgewandelt wird. <text> wird dann
                 1:1 und ohne Berücksichtigung etwaiger UDO-Kommandos
                 ausgegeben.

 Siehe auch:     !=html, !ifdest, Formatspezifisches, raw-Umgebung


F.8.4  !html_merge_nodes
------------------------

Kapitel zusammenfassen (nur HTML)

 Typ & Position: Schalter, Vorspann

 Syntax:         !html_merge_nodes

 Beschreibung:   Wird dieser Schalter im Vorspann angeben, so werden
                 alle Kapitel, Abschnitte und Unterabschnitte bei der
                 Umwandlung ins HTML-Format in einer Datei
                 zusammengefaßt.

 Siehe auch:     !html_merge_subnodes, !html_merge_subsubnodes


F.8.5  !html_merge_subnodes
---------------------------

Abschnitte zusammenfassen (nur HTML)

 Typ & Position: Schalter, Vorspann

 Syntax:         !html_merge_subnodes

 Beschreibung:   Wird dieser Schalter im Vorspann angegeben, so
                 erscheint der Inhalt der Abschnitte in der gleichen
                 Datei wie der des zugehörigen Kapitels.

 Siehe auch:     !html_merge_nodes, !html_merge_subsubnodes


F.8.6  !html_merge_subsubnodes
------------------------------

Unterabschnitte zusammenfassen (nur HTML)

 Typ & Position: Schalter, Vorspann

 Syntax:         !html_merge_subsubnodes

 Beschreibung:   Wird dieser Schalter im Vorspann angegeben, so
                 erscheint der Inhalt der Unterabschnitte in der
                 gleichen Datei wie der des zugehörigen Abschnitts.

 Siehe auch:     !html_merge_nodes, !html_merge_subnodes


F.8.7  !html_use_xlist
----------------------

Xlist-Umgebungen wie bei ASCII ausgeben (nur HTML)

 Typ & Position: Schalter, Vorspann

 Syntax:         !html_use_xlist

 Beschreibung:   Da die Ausgabe der xlist-Umgebung beim HTML-Format
                 ziemlich kritisch ist, werden xlist-Umgebung
                 standardmäßig wie description-Umgebungen behandelt.
                 Durch die Angabe dieses Schalters im Vorspann werden
                 xlist-Umgebungen jedoch wie beim ASCII-Format -
                 geklammert mit dem Preformatted-Tag - ausgegeben.

 Siehe auch:     Listen


F.8.8  !htmlname
----------------

Dateinamen zuweisen (nur HTML)

 Typ & Position: Kommando, Hauptteil

 Syntax:         !htmlname <datei>

 Beschreibung:   Taucht dieses Kommando innerhalb eines Kapitels,
                 Abschnitts oder Unterabschnitts auf, so wird dieser
                 Name anstelle von c_KKAAUU (KK Kapitelnummer, AA
                 Abschnittnummer, UU Unterabschnittnummer) für die
                 spätere HTML-Datei verwendet.

 Beispiel:       !htmlname software


F.8.9  !hyphen
--------------

Einen Trennvorschlag global setzen.

 Typ & Position: Kommando, Vorspann

 Syntax:         !hyphen <wort>

 Beschreibung:   Mit diesem Kommando können Sie UDO einen globalen
                 Trennvorschlag unterbreiten. In "<text>" sind die
                 Stellen mit der Zeichenfolge !- zu markieren, an denen
                 ein Wort getrennt werden darf. Im folgenden Beispiel
                 wird gezeigt, wie man die möglichen Trennstellen des
                 Wortes "Silbentrennung" setzen kann.

 Beispiel:       !hyphen Sil!-ben!-tren!-nung

 Siehe auch:     Silbentrennung, !sloppy, !fussy


F.9  I...
=========


F.9.1  !=info
-------------

Zeile nicht beim Texinfo-Format ausgeben.

 Typ & Position: Kommando, Vorspann & Hauptteil

 Syntax:         !=info <text>

 Beschreibung:   <text> wird nur dann ausgegeben, wenn die Quelldatei
                 nicht ins Texinfo-Format umgewandelt wird. <text>
                 wird dann 1:1 und ohne Berücksichtigung etwaiger
                 UDO-Kommandos ausgegeben. Diese Zeile zerteilt
                 Absätze genau wie alle anderen Kommandos.

 Siehe auch:     !info, !ifdest, Formatspezifisches, raw-Umgebung


F.9.2  !ifdest
--------------

Spezielle Umgebung beginnen

 Typ & Position: Kommando, Vorspann & Hauptteil

 Syntax:         !ifdest [<kürzel>]

 Beschreibung:   Dieses Kommando beginnt eine spezielle Umgebung,
                 deren Inhalt bis !else bzw. !endif nur dann
                 umgewandelt wird, wenn das passende Kürzel des Aus-
                 gabeformats als Parameter angegeben wird. Im
                 folgenden Beispiel geschieht dies für das ST-Guide-
                 bzw. WinHelp-Format.

 Beispiel:       !ifdest [stg,win]

 Siehe auch:     !else, !endif


F.9.3  !iflang
--------------

Spezielle, sprachabhängige Umgebung beginnen.

 Typ & Position: Kommando, Vorspann & Hauptteil

 Syntax:         !iflang [ german | english | french ]

 Beschreibung:   Dieses Kommando leitet eine sprachabhängige Umgebung
                 ein. Im Beispiel werden die bis !else bzw. !endif
                 folgenden Zeilen nur bearbeitet, wenn im Vorspann
                 !english benutzt wird.

 Beispiel:       !iflang [english]

 Siehe auch:     !ifdest, !english, !frensh, !german


F.9.4  !image
-------------

Grafik zentriert ausgeben

 Typ & Position: Kommando, Hauptteil

 Syntax:         !image <datei>

 Beschreibung:   Dieses Kommando erzeugt in der Ausgabedatei Befehle
                 zur Einbindung des Bildes. Die Endung der Datei
                 sollte nicht übergeben werden, da UDO dies selbst
                 erledigt. UDO benutzt .img beim ST-Guide, CSTeX und
                 Lindner-TeX, .gif für HTML, .msp oder .pcx für emTeX
                 und .bmp für WinHelp.

 Beispiel:       !image tiger

 Siehe auch:     !no_images, (!image ...), Bilder


F.9.5  !include
---------------

Datei einbinden

 Typ & Position: Kommando, Vorspann & Hauptteil

 Syntax:         !include <datei>

 Beschreibung:   Öffnet die Datei "<datei>" und gibt deren
                 umgewandelten Inhalt an der Stelle aus, an der
                 dieses Kommando benutzt wurde.

 Siehe auch:     !vinclude, !rinclude, Verteilte Dokumente


F.9.6  !index
-------------

Indexeintrag bzw. Schlüsselword setzen

 Typ & Position: Kommando, Hauptteil

 Syntax:         !index <text>

 Beschreibung:   <text> wird für LaTeX als \index {...} und für
                 WinHelp als K{\footnote K ...} ausgegeben. <text>
                 kommt damit bei LaTeX in den Index, bei WinHelp kann
                 man im Suchen-Dialog nach diesem Schlüsselwort
                 suchen und bekommt die Namen der Kapitel
                 aufgelistet, in denen !keyword benutzt wurde. <text>
                 kann beliebig oft benutzt werden, auch in mehreren
                 Kapiteln.

 Beispiel:       !index Eintrag, Index

 Siehe auch:     Indizes


F.9.7  !info
------------

Texinfo-Zeile ausgeben

 Typ & Position: Kommando, Vorspann & Hauptteil

 Syntax:         !info <text>

 Beschreibung:   <text> wird nur dann ausgegeben, wenn die Quelldatei
                 ins Texinfo-Format umgewandelt wird. <text> wird
                 dann 1:1 und ohne Berücksichtigung etwaiger UDO-
                 Kommandos ausgegeben. Diese Zeile zerteilt Absätze
                 genau wie alle anderen Kommandos.

 Siehe auch:     !=info, !ifdest, Formatspezifisches, raw-Umgebung


F.9.8  !item
------------

Aufzählungspunkt einleiten

 Typ & Position: Kommando, Hauptteil

 Syntax:         !item <text>

 Beschreibung:   Leitet einen neuen Aufzählungspunkt einer itemize-
                 Umgebung oder enumerate-Umgebung ein. Dieser wird
                 mit einer Marke bzw. mit einem alphanumerischen Wert
                 gekennzeichnet.

 Siehe auch:     !item [<text>], Einfache Aufzählungen, Numerierte
                 Aufzählungen


F.9.9  !item []
---------------

Aufzählungspunkt einleiten

 Typ & Position: Kommando, Hauptteil

 Syntax:         !item [<text>] <text>

 Beschreibung:   Leitet einen neuen Aufzählungspunkt einer
                 description-Umgebung oder einer xlist-Umgebung ein.
                 Der Text, der in eckige Klammern eingefaßt wird,
                 wird bei der description-Umgebung in der Ausgabe-
                 datei fett dargestellt.

 Siehe auch:     !item, Beschreibende Aufzählungen, Listen


F.9.10  (!I)...(!i)
-------------------

Kursiver Text

 Typ & Position: Platzhalter, Vorspann & Hauptteil

 Syntax:         (!I)<text>(!i)

 Beschreibung:   "<text>" wird kursiv dargestellt, falls möglich.

 Beispiel:       (!I)kursiv(!i)

 Siehe auch:     Texthervorhebungen


F.9.11  (!idx ...)
------------------

Indexeintrag setzen (nur TeX)

 Typ & Position: Platzhalter, Hauptteil

 Syntax:         (!idx [<text>] {[<index1>]} {[<index2>]}
                 {[<index3>]} )

 Beschreibung:   Dient zum Erzeugen von Indizes direkt im Quelltext.
                 Indizes werden momentan nur für LaTeX umgesetzt. Bei
                 allen anderen Formaten wird lediglich <text>
                 ausgegeben.

 Siehe auch:     Indizes


F.9.12  (!ilink ...)
--------------------

Querverweis mit Grafik

 Typ & Position: Platzhalter, Hauptteil

 Syntax:         (!ilink [<datei>] [<text>] [<link>])

 Beschreibung:   Dieser Platzhalter ist eine Kombination der
                 Platzhalter (!image ...) und (!link ...) und dient
                 dazu, einen Querverweis durch eine Grafik zu
                 ermöglichen. Dies ist momentan nur beim WinHelp- und
                 HTML-Format möglich. Im Beispiel wird das Bild
                 disk.bmp bzw. disk.gif zur Darstellung des Links
                 benutzt, das Sprungziel lautet "Download". Bei HTML
                 wird als Alternativtext "UDO downloaden" ausgegeben.

 Beispiel:       (!ilink [disk] [UDO downloaden] [Download]

 Siehe auch:     (!image ...) (!link ...), Querverweise, Bilder


F.9.13  (!img ...)
------------------

Grafik ausgeben

 Typ & Position: Platzhalter, Hauptteil

 Syntax:         (!img [<file>] [<text>])

 Beschreibung:   Benutzen Sie dieses Kommando, um ein Bild direkt im
                 Text bei der Umwandlung nach HTML oder WinHelp
                 auszugeben. Bei der Umwandlung nach HTML wird
                 file.gif, bei WinHelp file.bmp benutzt, wobei UDO
                 nicht überprüft, ob die jeweiligen Bilder
                 existieren. Bei HTML wird "<text>" als
                 Alternativtext bentutzt. Bei den anderen Formaten
                 wird nur "<text>" ausgegeben.

 Beispiel:       (!img [dh] [mein Logo])

 Siehe auch:     Bilder, !image


F.10  L...
==========


F.10.1  !=ldoc
--------------

Zeile nicht beim Linuxdoc-SGML-Format ausgeben.

 Typ & Position: Kommando, Vorspann & Hauptteil

 Syntax:         !=ldoc <text>

 Beschreibung:   <text> wird nur dann ausgegeben, wenn die Quelldatei
                 nicht ins Linuxdoc-SGML-Format umgewandelt wird.
                 <text> wird dann 1:1 und ohne Berücksichtigung
                 etwaiger UDO-Kommandos ausgegeben. Diese Zeile
                 zerteilt Absätze genau wie alle anderen Kommandos.

 Siehe auch:     !ldoc, !ifdest, Formatspezifisches, raw-Umgebung


F.10.2  !label
--------------

Sprungmarke setzen

 Typ & Position: Kommando, Hauptteil

 Syntax:         !label <text>

 Beschreibung:   Definiert eine Sprungmarke, die bei Hyper-
                 textformaten automatisch referenziert wird und auf
                 die man durch die Link-Befehle verweisen kann.

 Beispiel:       !link Sprungmarke

 Siehe auch:     Sprungmarken, Querverweise


F.10.3  !ldoc
-------------

 Typ & Position: Kommando, Vorspann & Hauptteil

 Syntax:         !ldoc <text>

 Beschreibung:   <text> wird nur dann ausgegeben, wenn die Quelldatei
                 ins Linuxdoc-SGML-Format umgewandelt wird. <text>
                 wird dann 1:1 und ohne Berücksichtigung etwaiger
                 UDO-Kommandos ausgegeben. Diese Zeile zerteilt
                 Absätze genau wie alle anderen Kommandos.

 Siehe auch:     !=ldoc, !ifdest, Formatspezifisches, raw-Umgebung


F.10.4  !list_parsep
--------------------

Benutzung von Leerzeilen in Aufzählungen ein-/ausschalten

 Typ & Position: Schalter, Vorspann & Hauptteil

 Syntax:         !list_parsep [ on | off ]

 Beschreibung:   !list_parsep [off] sorgt dafür, daß Items der
                 nächsten itemize-, enumerate-, description- oder
                 xlist-Umgebung nicht durch Leerzeilen voneinander
                 getrennt werden. !list_parsep [on] schaltet die
                 Benutzung von trennenden Leerzeilen wieder ein. [on]
                 ist die Standardeinstellung.

 Beispiel:       !list_parsep [off]

 Siehe auch:     Texthervorhebungen


F.10.5  (!LaTeX)
----------------

LaTeX-Schriftzug ausgeben

 Typ & Position: Platzhalter, Vorspann & Hauptteil

 Syntax:         (!LaTeX)

 Beschreibung:   Dieser Platzhalter wird bei der Umwandlung ins
                 LaTeX-Format in \LaTeX{}, ansonsten in "LaTeX"
                 umgewandelt.

 Siehe auch:     (!TeX), (!LaTeXe)


F.10.6  (!LaTeXe)
-----------------

LaTeX2e-Schriftzug ausgeben

 Typ & Position: Platzhalter, Vorspann & Hauptteil

 Syntax:         LaTeX2e

 Beschreibung:   Dieser Platzhalter wird bei der Umwandlung ins
                 LaTeX-Format in \LaTeXe{}, ansonsten in "LaTeX2e"
                 umgewandelt.

 Siehe auch:     (!TeX), (!LaTeX)


F.10.7  (!laugh)
----------------

Emoticon ausgeben

 Typ & Position: Platzhalter, Vorspann & Hauptteil

 Syntax:         (!laugh)

 Beschreibung:   Dieser Platzhalter wird durch einen lachenden Smiley
                 ersetzt, der in Schreibmaschinenschrift ausgegeben
                 wird.

 Beispiel:       Aus (!laugh) wird :-)

 Siehe auch:     (!grin)


F.10.8  (!link ...)
-------------------

Manuellen Querverweis durchführen.

 Typ & Position: Platzhalter, Hauptteil

 Syntax:         (!link [<text>] [<link>])

 Beschreibung:   Hiermit können Querverweise auf andere Kapitel oder
                 Sprungmarken vorgenommen werden. Ausführliche
                 Informationen finden man im Abschnitt
                 "Querverweise".

 Beispiel:       (!link [Links] [Querverweise])

 Siehe auch:     (!xlink ...), (!plink ...), Querverweise


F.11  M...
==========


F.11.1  !=man
-------------

Zeile nicht beim Manualpage-Format ausgeben.

 Typ & Position: Kommando, Vorspann & Hauptteil

 Syntax:         !=man <text>

 Beschreibung:   <text> wird nur dann ausgegeben, wenn die Quelldatei
                 nicht ins Manualpage-Format umgewandelt wird. <text>
                 wird dann 1:1 und ohne Berücksichtigung etwaiger
                 UDO-Kommandos ausgegeben. Diese Zeile zerteilt
                 Absätze genau wie alle anderen Kommandos.

 Siehe auch:     !man, !ifdest, Formatspezifisches, raw-Umgebung


F.11.2  !macro
--------------

Makro definieren

 Typ & Position: Kommando, Vorspann

 Syntax:         !macro <wort> <text>

 Beschreibung:   Dieses Kommando definiert ein neues Makro. Bei der
                 Umwandlung wird dann "(!<wort>)" durch "<text>"
                 ersetzt. Im Beispiel würde "(!DH)" durch "Dirk
                 Hagedorn" ersetzt.

 Beispiel:       !macro DH Dirk Hagedorn

 Siehe auch:     Makros


F.11.3  !maketitle
------------------

Titelseite ausgeben

 Typ & Position: Kommando, Hauptteil

 Syntax:         !maketitle

 Beschreibung:   Dieses Kommando erzeugt in der Zieldatei eine
                 Titelseite, die aus den Informationen der unteren
                 Befehle gebildet wird. Wenn !maketitle benutzt wird,
                 sollte es nur direkt nach !begin_document eingesetzt
                 werden.

 Siehe auch:     !title, !program, !programimage, !version, !date,
                 !author, !authorimage, !street, !title, !email,
                 Titelseite


F.11.4  !man
------------

Zeile nur für das Manualpage-Format ausgeben

 Typ & Position: Kommando, Vorspann & Hauptteil

 Syntax:         !man <text>

 Beschreibung:   <text> wird nur dann ausgegeben, wenn die Quelldatei
                 ins Manualpage-Format umgewandelt wird. <text> wird
                 dann 1:1 und ohne Berücksichtigung etwaiger UDO-
                 Kommandos ausgegeben. Diese Zeile zerteilt Absätze
                 genau wie alle anderen Kommandos.

 Siehe auch:     !=man, Formatspezifisches, raw-Umgebung


F.11.5  !man_lpp
----------------

Zeilen pro Seite setzen (nur Manualpage)

 Typ & Position: Kommando, Vorspann

 Syntax:         !man_lpp <wert>

 Beschreibung:   Setzt die Anzahl der Zeilen pro Seite ("lines per
                 page") einer Manualpage. Im Fußbereich werden dann
                 zusätzlich Seitennummern ausgegeben. Beim Start der
                 Umwandlung ist die Seitenlänge undefiniert und es
                 werden auch keine Fußzeilen ausgegeben.

 Beispiel:       !man_lpp 60

 Siehe auch:     !use_formfeed


F.11.6  !man_type
-----------------

Programmtyp setzen (nur Manualpage)

 Typ & Position: Kommando, Vorspann

 Syntax:         !man_type <text>

 Beschreibung:   "<text>" wird bei der Ausgabe in eine Manualpage in
                 Klammern in der Kopfzeile ausgegeben. Im Beispiel
                 würde bei benutztem "!program udo" die Kopfzeile
                 "udo(1)" ausgegeben. "<text>" wird nicht als
                 Dateiendung benutzt.

 Beispiel:       !man_type 1


F.11.7  !medskip
----------------

Zwei zusätzliche Leerzeilen einfügen

 Typ & Position: Kommando, Hauptteil

 Syntax:         !medskip

 Beschreibung:   Wird bei der Ausgabe ins LaTeX-Format durch
                 "\medskip" ersetzt. Ansonsten werden zwei
                 zusätzliche Leerzeilen ausgegeben.

 Siehe auch:     !smallskip, !bigskip


F.12  N...
==========


F.12.1  !newpage
----------------

Seitenumbruch erzeugen

 Typ & Position: Kommando, Hauptteil

 Syntax:         !newpage

 Beschreibung:   Erzeugt in der Ausgabedatei einen Seitenumbruch,
                 falls das Ausgabeformat Seitenumbrüche unterstützt.

 Siehe auch:     !use_formfeed


F.12.2  !no_bottomlines
-----------------------

Keine Fußzeilen benutzen

 Typ & Position: Schalter, Vorspann

 Syntax:         !no_bottomlines [<kürzel>]

 Beschreibung:   Mit diesem Kommando kann man die automatische
                 Erzeugung von Fußzeilen der jeweiligen Ausgabe-
                 formate unterbinden. Im Beispiel würde dies bei der
                 Umwandlung ins Pure-C-Help-Format geschehen.

 Beispiel:       !no_bottomlines [pch]


F.12.3  !no_effects
-------------------

Keine Schriftarten benutzen

 Typ & Position: Schalter, Vorspann

 Syntax:         !no_effects [<kürzel>]

 Beschreibung:   Schaltet die Benutzung von Schriftarten aus. Im
                 Beispiel würden diese bei der Umwandlung ins ASCII-
                 Format nicht benutzt.

 Beispiel:       !no_effects [asc]

 Siehe auch:     Schriftarten


F.12.4  !no_headlines
---------------------

Keine Kopfzeilen benutzen

 Typ & Position: Schalter, Vorspann

 Syntax:         !no_headlines [<kürzel>]

 Beschreibung:   Mit diesem Kommando kann man die automatische
                 Erzeugung von Fußzeilen der jeweiligen Ausgabe-
                 formate unterbinden. Im Beispiel würde dies bei der
                 Umwandlung ins WinHelp-Format geschehen.

 Beispiel:       !no_headlines [win]


F.12.5  !no_images
------------------

Keine Grafiken benutzen

 Typ & Position: Kommando, Vorspann

 Syntax:         !no_images [<kürzel>]

 Beschreibung:   Mit diesem Kommando läßt sich die Ausgabe von
                 Befehlen zur Ausgabe von Bildern für ein Ausgabe-
                 format unterbinden. Im Beispiel würden keine Befehle
                 zur Ausgabe von Bildern beim HTML-Format erzeugt.

 Beispiel:       !no_images [html]

 Siehe auch:     !image, Bilder


F.12.6  !no_numbers
-------------------

Keine Kapitelnummern benutzen

 Typ & Position: Schalter, Vorspann

 Syntax:         !no_numbers [<kürzel>]

 Beschreibung:   Dieses Kommando schaltet die Ausgabe von
                 Kapitelnummern aus. In Inhaltsverzeichnissen werden
                 dann nur die Kapitelnamen ausgegeben. Im Beispiel
                 wird dies für das WinHelp-Format und für HTML
                 gemacht.

 Beispiel:       !no_numbers [win,html]

 Siehe auch:     !tableofcontents, !toc, !subtoc, !subsubtoc


F.12.7  !no_quotes
------------------

Keine echten Anführungsstriche benutzen

 Typ & Position: Schalter, Vorspann

 Syntax:         !no_quotes [<kürzel>]

 Beschreibung:   Schaltet die Umwandlung von doppelten in echte An-
                 führungszeichen und Apostrophen aus. Doppelte An-
                 führungszeichen und Apostrope werden dann durch
                 einfache ersetzt.

 Beispiel:       !no_quotes [asc,man]

 Siehe auch:     Anführungszeichen, Apostrophe


F.12.8  !no_umlaute
-------------------

Keine Umlaute benutzen

 Typ & Position: Schalter, Vorspann

 Syntax:         !no_umlaute [<kürzel>]

 Beschreibung:   Umlaute, die im Quelltext vorkommen, werden in der
                 Zieldatei durch ae, oe, ue, ss, Ae, Oe und Ue
                 ausgegeben. Im Beispiel würde dies bei der
                 Umwandlung ins Manualpage-Format geschehen.

 Beispiel:       !no_umlaute [man]

 Siehe auch:     Sonderzeichen


F.12.9  !no_xlinks
------------------

Keine externen Verweise benutzen

 Typ & Position: Schalter, Vorspann

 Syntax:         !no_xlinks [<kürzel>]

 Beschreibung:   Dieser Befehl schaltet die Benutzung von externen
                 Verweisen aus, falls das formatzugehörige Kürzel
                 angegeben wurde. Dies ist sinnvoll, falls man einen
                 Hypertext mit HTML-Links versehen hat, die jedoch
                 weder in einem WinHelp- noch ST-Guide-Hypertext Sinn
                 machen würden.

 Beispiel:       !no_xlink [stg]

 Siehe auch:     (!xlink ...)


F.12.10  !node
--------------

Kapitel einleiten

 Typ & Position: Kommando, Hauptteil

 Syntax:         !node <text>

 Beschreibung:   Leitet ein Kapitel mit der Bezeichnung "<text>" ein.
                 Kapitel erscheinen in Inhaltsverzeichnissen.

 Beispiel:       !node Befehlsindex

 Siehe auch:     !pnode, !subnode, !subsubnode, Gliederung


F.12.11  !node*
---------------

Kapitel ohne Eintrag im Inhaltsverzeichnis einleiten

 Typ & Position: Kommando, Hauptteil

 Syntax:         !node* <text>

 Beschreibung:   Dieses Kommando hat die gleiche Funktion wie !node,
                 mit der Ausnahme, daß "<text>" nicht in Inhalts-
                 verzeichnissen erscheint.

 Siehe auch:     !node, !pnode*, Gliederung


F.12.12  (!N)...(!n)
--------------------

Fußnote erzeugen

 Typ & Position: Platzhalter, Vorspann & Hauptteil

 Syntax:         (!N)<text>(!n)

 Beschreibung:   "<text>" wird als Fußnote oder in Klammern
                 dargestellt. Vor (!N) sollte sich kein Leerzeichen,
                 Tabulator oder Zeilenumbruch befinden!

 Beispiel:       (!N)eine Fußnote(!n)

 Siehe auch:     Fußnoten


F.12.13  (!nl)
--------------

Manuellen Zeilenumbruch setzen

 Typ & Position: Platzhalter, Hauptteil

 Syntax:         (!nl)

 Beschreibung:   Durch (!nl) kann man einen Zeilenumbruch erzwingen.
                 Vor (!nl) muß ein (festes) Leerzeichen stehen! Nach
                 (!nl) muß ebenfalls ein (festes) Leerzeichen stehen
                 oder (!nl) muß das letzte Wort einer Zeile sein.

 Beispiel:       Ein manueller (!nl) Zeilenumbruch


F.13  O...
==========


F.13.1  (!O)...(!o)
-------------------

Text "outlined" darstellen.

 Typ & Position: Platzhalter, Vorspann & Hauptteil

 Syntax:         (!O)<text>(!o)

 Beschreibung:   "<text>" wird "outlined" dargestellt, falls möglich.

 Beispiel:       (!O)outlined(!o)

 Siehe auch:     Texthervorhebungen


F.14  P...
==========


F.14.1  !=pch
-------------

Zeile nicht beim Pure-C-Help-Format ausgeben.

 Typ & Position: Kommando, Vorspann & Hauptteil

 Syntax:         !=pch <text>

 Beschreibung:   <text> wird nur dann ausgegeben, wenn die Quelldatei
                 nicht ins Pure-C-Help-Format umgewandelt wird.
                 <text> wird dann 1:1 und ohne Berücksichtigung
                 etwaiger UDO-Kommandos ausgegeben. Diese Zeile
                 zerteilt Absätze genau wie alle anderen Kommandos.

 Siehe auch:     !pch, !ifdest, Formatspezifisches, raw-Umgebung


F.14.2  !pch
------------

Zeile für Pure-C-Help ausgeben

 Typ & Position: Kommando, Vorspann & Hauptteil

 Syntax:         !pch <text>

 Beschreibung:   <text> wird nur dann ausgegeben, wenn die Quelldatei
                 ins Pure-C-Help-Format umgewandelt wird. <text> wird
                 dann 1:1 und ohne Berücksichtigung etwaiger UDO-
                 Kommandos ausgegeben. Diese Zeile zerteilt Absätze
                 genau wie alle anderen Kommandos.

 Siehe auch:     !=pch, Formatspezifisches, raw-Umgebung


F.14.3  !pnode
--------------

Popup-Kapitel einleiten

 Typ & Position: Kommando, Hauptteil

 Syntax:         !pnode <text>

 Beschreibung:   Identisch mit "!node", der Inhalt wird jedoch beim
                 ST-Guide und bei WinHelp als Popup dargestellt.

 Siehe auch:     !psubnode, !psubsubnode


F.14.4  !pnode*
---------------

Popup-Kapitel ohne Eintrag im Inhaltsverzeichnis einleiten

 Typ & Position: Kommando, Hauptteil

 Syntax:         !psubnode* <text>

 Beschreibung:   Dieses Kommando hat die gleiche Funktion wie !pnode,
                 mit der Ausnahme, daß "<text>" nicht in Inhalts-
                 verzeichnissen erscheint.

 Siehe auch:     !pnode, !node*, Gliederung


F.14.5  !program
----------------

Programmnamen für Titelseite definieren

 Typ & Position: Kommando, Vorspann

 Syntax:         !program <text>

 Beschreibung:   "<text>" wird auf der Titelseite unterhalb der
                 Titelzeile ausgegeben. Desweiteren wird "<text>" bei
                 einigen Formaten zur Darstellung von Kopfzeilen
                 herangezogen.

 Beispiel:       !program UDO

 Siehe auch:     !maketitle, !programimage, Titelseite


F.14.6  !programimage
---------------------

Programmgrafik für Titelseite definieren

 Typ & Position: Kommando, Vorspann

 Syntax:         !programimage <datei>

 Beschreibung:   Das Bild <datei> wird anstelle des Inhalts von
                 (!program) unterhalb der Titelzeile auf der
                 Titelseite ausgegeben.

 Beispiel:       !programimage udo

 Siehe auch:     !maketitle, !program, Titelseite


F.14.7  !psubnode
-----------------

Popup-Abschnitt einleiten

 Typ & Position: Kommando, Hauptteil

 Syntax:         !psubnode <text>

 Beschreibung:   Identisch mit "!subnode", der Inhalt wird jedoch
                 beim ST-Guide und bei WinHelp als Popup dargestellt.

 Siehe auch:     !pnode, !psubsubnode


F.14.8  !psubnode*
------------------

Popup-Abschnitt ohne Eintrag im Inhaltsverzeichnis einleiten

 Typ & Position: Kommando, Hauptteil

 Syntax:         !psubnode* <text>

 Beschreibung:   Dieses Kommando hat die gleiche Funktion wie
                 !psubnode, mit der Ausnahme, daß "<text>" nicht in
                 Inhaltsverzeichnissen erscheint.

 Siehe auch:     !psubnode, !subnode*, Gliederung


F.14.9  !psubsubnode
--------------------

Popup-Unterabschnitt einleiten

 Typ & Position: Kommando, Hauptteil

 Syntax:         !psubsubnode <text>

 Beschreibung:   Identisch mit "!subsubnode", der Inhalt wird jedoch
                 beim ST-Guide und bei WinHelp als Popup dargestellt.

 Siehe auch:     !pnode, !psubnode


F.14.10  !psubsubnode*
----------------------

Popup-Unterabschnitt ohne Eintrag im Inhaltsverzeichnis

 Typ & Position: Kommando, Hauptteil

 Syntax:         !psubsubnode* <text>

 Beschreibung:   Dieses Kommando hat die gleiche Funktion wie
                 !psubsubnode, mit der Ausnahme, daß "<text>" nicht
                 in Inhaltsverzeichnissen erscheint.

 Siehe auch:     !psubsubnode, !subsubnode*, Gliederung


F.14.11  (!plink ...)
---------------------

Manuellen Seitenverweis setzen (nur TeX)

 Typ & Position: Platzhalter, Hauptteil

 Syntax:         (!plink [<text>] [<link>])

 Beschreibung:   Dieser Befehl ist derzeit nur für LaTeX sinnvoll und
                 erzeugt einen Seitenbezug auf einen anderen Teil des
                 Dokuments. Bei allen anderen Formaten wird lediglich
                 <text ausgegeben.

 Siehe auch:     (!link ...), (!xlink ...), Querverweise


F.15  R...
==========


F.15.1  !=rtf
-------------

Zeile nicht beim RTF ausgeben.

 Typ & Position: Kommando, Vorspann & Hauptteil

 Syntax:         !=rtf <text>

 Beschreibung:   <text> wird nur dann ausgegeben, wenn die Quelldatei
                 nicht ins Rich Text Format umgewandelt wird. <text>
                 wird dann 1:1 und ohne Berücksichtigung etwaiger
                 UDO-Kommandos ausgegeben. Diese Zeile zerteilt
                 Absätze genau wie alle anderen Kommandos.

 Siehe auch:     !rtf, !ifdest, Formatspezifisches, raw-Umgebung


F.15.2  !rinclude
-----------------

Datei 1:1 einbinden

 Typ & Position: Kommando, Hauptteil

 Syntax:         !rinclude <datei>

 Beschreibung:   Öffnet die Datei "<datei>" und gibt deren Inhalt
                 unformatiert an der Stelle aus, an der dieses
                 Kommando benutzt wurde. Der Inhalt der Datei wird
                 nicht eingerückt oder zentriert ausgegeben. Die raw-
                 Umgebung dient dazu, spezielle Formatbefehle
                 einzubinden.

 Siehe auch:     !include, !vinclude, Verteilte Dokumente, raw-
                 Umgebung


F.15.3  !rtf
------------

Zeile für das RTF ausgeben

 Typ & Position: Kommando, Vorspann & Hauptteil

 Syntax:         !rtf <text>

 Beschreibung:   <text> wird nur dann ausgegeben, wenn die Quelldatei
                 ins Rich Text Format umgewandelt wird. <text> wird
                 dann 1:1 und ohne Berücksichtigung etwaiger UDO-
                 Kommandos ausgegeben. Diese Zeile zerteilt Absätze
                 genau wie alle anderen Kommandos.

 Siehe auch:     !=rtf, Formatspezifisches, raw-Umgebung


F.15.4  !rtf_monofont
---------------------

Namen des Monospaced-Font für RTF setzen

 Typ & Position: Kommando, Vorspann

 Syntax:         !rtf_monofont <fontname>

 Beschreibung:   Mit diesem Kommando kann man den Font setzen, der
                 zur Darstellung von Klartext benutzt werden soll.
                 Als Default verwendet UDO den Font "Monospace 821".

 Beispiel:       !rtf_monofont Courier New

 Siehe auch:     !rtf_propfont


F.15.5  !rtf_propfont
---------------------

Namen des Proportional-Fonts für RTF setzen

 Typ & Position: Kommando, Vorspann

 Syntax:         !rtf_propfont <fontname>

 Beschreibung:   Mit diesem Kommando kann man den Font setzen, der
                 zur Darstellung von Fließtext und Überschriften
                 benutzt werden soll. Als Default verwendet UDO den
                 Font "Dutch 801 Roman".

 Beispiel:       !rtf_propfont Times New Roman

 Siehe auch:     !rtf_monofont


F.16  S...
==========


F.16.1  !=stg
-------------

Zeile nicht beim ST-Guide-Format ausgeben.

 Typ & Position: Kommando, Vorspann & Hauptteil

 Syntax:         !=stg <text>

 Beschreibung:   <text> wird nur dann ausgegeben, wenn die Quelldatei
                 nicht ins ST-Guide-Format umgewandelt wird. <text>
                 wird dann 1:1 und ohne Berücksichtigung etwaiger
                 UDO-Kommandos ausgegeben. Diese Zeile zerteilt
                 Absätze genau wie alle anderen Kommandos.

 Siehe auch:     !stg, !ifdest, Formatspezifisches, raw-Umgebung


F.16.2  !sloppy
---------------

Warnungen vor kurzen Zeilen ausschalten

 Typ & Position: Schalter, Hauptteil

 Syntax:         !sloppy

 Beschreibung:   Schaltet die Warnung vor kurzen Zeilen aus, die
                 ausgegeben werden, wenn ein grober rechter
                 Flatterrand erzeugt wird. Bei der Umwandlung ins
                 LaTeX-Format erfolgt keine Umsetzung in \sloppy!

 Siehe auch:     !fussy, Fehlermeldungen, Silbentrennung


F.16.3  !smallskip
------------------

Eine zusätzliche Leerzeile einfügen

 Typ & Position: Kommando, Hauptteil

 Syntax:         !smallskip

 Beschreibung:   Wird bei der Ausgabe ins LaTeX-Format durch
                 "\smallskip" ersetzt. Ansonsten wird eine
                 zusätzliche Leerzeile ausgegeben.

 Siehe auch:     !medskip, !bigskip


F.16.4  !stg
------------

Zeile für den ST-Guide ausgeben

 Typ & Position: Kommando, Vorspann & Hauptteil

 Syntax:         !stg <text>

 Beschreibung:   <text> wird nur dann ausgegeben, wenn die Quelldatei
                 ins ST-Guide-Format umgewandelt wird. <text> wird
                 dann 1:1 und ohne Berücksichtigung etwaiger UDO-
                 Kommandos ausgegeben. Diese Zeile zerteilt Absätze
                 genau wie alle anderen Kommandos.

 Beispiel:       !stg @subject "Dokumentation\Utilities"

 Siehe auch:     !=stg, Formatspezifisches, raw-Umgebung


F.16.5  !stg_no_database
------------------------

Keine Database-Zeile ausgeben (nur ST-Guide)

 Typ & Position: Schalter, Vorspann

 Syntax:         !stg_no_database

 Beschreibung:   Wird dieser Schalter im Vorspann angegeben, so wird
                 bei der Umwandlung ins ST-Guide-Format die Ausgabe
                 der @database-Zeile unterbunden. Standardmäßig
                 erzeugt UDO diese Zeile selber aus den Daten von
                 !title und !program.


F.16.6  !street
---------------

Straße des Autors für den Adressblock der Titelseite setzen

 Typ & Position: Kommando, Vorspann

 Syntax:         !street <text>

 Beschreibung:   "<text>" wird auf der Titelseite unterhalb des
                 Namens des Autors ausgegeben. Ansonsten findet
                 "<text>" keine weitere Verwendung.

 Beispiel:       !street In der Esmecke 9

 Siehe auch:     !maketitle, Titelseite


F.16.7  !subnode
----------------

Abschnitt einleiten

 Typ & Position: Kommando, Hauptteil

 Syntax:         !subnode <text>

 Beschreibung:   Leitet einen Abschnitt mit der Bezeichnung "<text>"
                 ein. Abschnitte erscheinen in Inhaltsverzeichnissen.

 Beispiel:       !subnode S...

 Siehe auch:     !psubnode, !node, !subsubnode, Gliederung


F.16.8  !subnode*
-----------------

Abschnitt ohne Eintrag im Inhaltsverzeichnis einleiten

 Typ & Position: Kommando, Hauptteil

 Syntax:         !subnode* <text>

 Beschreibung:   Dieses Kommando hat die gleiche Funktion wie
                 !subnode, mit der Ausnahme, daß "<text>" nicht in
                 Inhaltsverzeichnissen erscheint.

 Siehe auch:     !subnode, !psubnode*, Gliederung


F.16.9  !subsubnode
-------------------

Unterabschnitt einleiten

 Typ & Position: Kommando, Hauptteil

 Syntax:         !subsubnode <text>

 Beschreibung:   Leitet einen Unterabschnitt mit der Bezeichnung
                 "<text>" ein. Unterabschnitte erscheinen in In-
                 haltsverzeichnissen.

 Beispiel:       !subsubnode !/subsubnode

 Siehe auch:     !psubsubnode, !node, !subnode, Gliederung


F.16.10  !subsubnode*
---------------------

Unterabschnitt ohne Eintrag im Inhaltsverzeichnis einleiten

 Typ & Position: Kommando, Hauptteil

 Syntax:         !subsubnode* <text>

 Beschreibung:   Dieses Kommando hat die gleiche Funktion wie
                 !subsubnode, mit der Ausnahme, daß "<text>" nicht in
                 Inhaltsverzeichnissen erscheint.

 Siehe auch:     !subsubnode, !psubsubnode*, Gliederung


F.16.11  !subsubtoc
-------------------

Unterabschnitte auflisten

 Typ & Position: Kommando, Hauptteil

 Syntax:         !subsubtoc [<kürzel>]

 Beschreibung:   Listet in Form eines Inhaltsverzeichnisses alle
                 Unterabschnitte des aktuellen Abschnitts aus und
                 sorgt dafür, daß man in Hypertexten zu den
                 Unterabschnitten weiterverzweigen kann.

 Beispiel:       !subsubtoc [html,pch,stg,win]

 Siehe auch:     !tableofcontents, !toc, !subtoc, !use_subsubtocs,
                 Inhaltsverzeichnisse


F.16.12  !subtoc
----------------

Abschnitte auflisten

 Typ & Position: Kommando, Hauptteil

 Syntax:         !subtoc [<kürzel>]

 Beschreibung:   Listet in Form eines Inhaltsverzeichnisses alle
                 Abschnitte des aktuellen Kapitels aus und sorgt
                 dafür, daß man in Hypertexten zu den Abschnitten
                 weiterverzweigen kann.

 Beispiel:       !subtoc [html,pch,stg,win]

 Siehe auch:     !tableofcontents, !subtoc, !subsubtoc, !use_subtocs,
                 Inhaltsverzeichnisse


F.16.13  (!S)...(!s)
--------------------

Text schattiert darstellen.

 Typ & Position: Platzhalter, Vorspann & Hauptteil

 Syntax:         (!S)<text>(!s)

 Beschreibung:   "<text>" wird schattiert dargestellt, falls möglich.

 Beispiel:       (!S)schattiert(!s)

 Siehe auch:     Texthervorhebungen


F.16.14  (!short_today)
-----------------------

Systemdatum in kurzer Schreibweise einsetzen.

 Typ & Position: Platzhalter, Vorspann & Hauptteil

 Syntax:         (!short_today)

 Beschreibung:   Dieser Platzhalter wird durch das bei der Umwandlung
                 aktuelle Systemdatum in kurzer Form ersetzt.

 Beispiel:       Aus (!short_today) wird 08.04.1996

 Siehe auch:     !german, !english, (!today)


F.17  T...
==========


F.17.1  !=tex
-------------

Zeile nicht beim LaTeX-Format ausgeben.

 Typ & Position: Kommando, Vorspann & Hauptteil

 Syntax:         !=tex <text>

 Beschreibung:   <text> wird nur dann ausgegeben, wenn die Quelldatei
                 nicht ins LaTeX-Format umgewandelt wird. <text> wird
                 dann 1:1 und ohne Berücksichtigung etwaiger UDO-
                 Kommandos ausgegeben. Diese Zeile zerteilt Absätze
                 genau wie alle anderen Kommandos.

 Siehe auch:     !tex, !ifdest, Formatspezifisches, raw-Umgebung


F.17.2  !tableofcontents
------------------------

Inhaltsverzeichnis ausgeben

 Typ & Position: Kommando, Hauptteil

 Syntax:         !tableofcontents

 Beschreibung:   Dieses Kommando gibt ein komplettes Inhaltsver-
                 zeichnis aus, welches durch ausgabeformatspezifische
                 Kommandos eingefaßt und in Hypertexten auf einer
                 eigenen Seite dargsetellt wird. Dieses Kommando
                 sollte direkt nach !begin_document bzw. nach
                 !maketitle eingesetzt werden.

 Siehe auch:     Inhaltsverzeichnisse, !use_short_toc


F.17.3  !tex
------------

Zeile für LaTeX ausgeben

 Typ & Position: Kommando, Vorspann & Hauptteil

 Syntax:         !tex <text>

 Beschreibung:   <text> wird nur dann ausgegeben, wenn die Quelldatei
                 ins LaTeX-Format umgewandelt wird. <text> wird dann
                 1:1 und ohne Berücksichtigung etwaiger UDO-Kommandos
                 ausgegeben. Diese Zeile zerteilt Absätze genau wie
                 alle anderen Kommandos.

 Beispiel:       !tex \documentstyle[11pt,german]{article}

 Siehe auch:     !=tex, Formatspezifisches, raw-Umgebung


F.17.4  !tex_2e
---------------

LaTeX2e-Kommandos benutzen (nur TeX)

 Typ & Position: Schalter, Vorspann

 Syntax:         !tex_2e

 Beschreibung:   UDO erzeugt bei der Umwandlung ins LaTeX-Format
                 spezielle LaTeX2e-Kommandos, so z.B. \textbf{...}
                 anstelle von {\bf ...}


F.17.5  !tex_dpi
----------------

Grafikauflösung setzen (nur TeX)

 Typ & Position: Kommando, Vorspann & Hauptteil

 Syntax:         !tex_dpi <wert>

 Beschreibung:   Setzt die Auflösung, mit der Bilder in LaTeX
                 ausgegeben werden sollen. Beim Lindner-TeX wird
                 dieser Wert herangezogen, um den Header eines GEM-
                 Images zu verändern.

 Beispiel:       !tex_dpi 100

 Siehe auch:     !tex_strunk, !tex_lindner, !tex_emtex, !image,
                 Bilder


F.17.6  !tex_emtex
------------------

Grafikmakros für emTeX erzeugen (nur TeX)

 Typ & Position: Schalter, Vorspann

 Syntax:         !tex_emtex

 Beschreibung:   Gibt an, daß bei der Einbindung von Windows-
                 Paintshop-Bildern ein TeX-Makro für emTeX erzeugt
                 werden soll.

 Siehe auch:     !tex_strunk, !tex_lindner, !image, Bilder


F.17.7  !tex_lindner
--------------------

Grafikmakros für Lindner-TeX erzeugen (nur TeX)

 Typ & Position: Schalter, Vorspann

 Syntax:         !tex_lindner

 Beschreibung:   Gibt an, daß bei der Einbindung von GEM-Images ein
                 TeX-Makro für das Lindner-TeX erzeugt werden soll.

 Siehe auch:     !tex_strunk, !tex_emtex, !image, Bilder


F.17.8  !tex_strunk
-------------------

Grafikmakros für CSTeX erzeugen (nur TeX)

 Typ & Position: Schalter, Vorspann

 Syntax:         !tex_strunk

 Beschreibung:   Gibt an, daß bei der Einbindung von GEM-Images ein
                 TeX-Makro für das CS- oder MultiTeX erzeugt werden
                 soll.

 Siehe auch:     !tex_lindner, !tex_emxtex, !image, Bilder


F.17.9  !tex_verb
-----------------

Verbatim-Zeichen für TeX setzen

 Typ & Position: Kommando, Vorspann & Hauptteil

 Syntax:         !tex_verb <zeichen>

 Beschreibung:   "<zeichen>" wird als Klammerungszeichen für den
                 LaTeX-Befehl \verb verwendet. Bei der nächsten
                 Umwandlung von (!V) und (!v) wird dann "<zeichen>"
                 benutzt. Als Defaultzeichen benutzt UDO "+".

 Beispiel:       !tex_verb |

 Siehe auch:     (!V)...(!v)


F.17.10  !title
---------------

Dokumenttitel definieren

 Typ & Position: Kommando, Vorspann

 Syntax:         !title <text>

 Beschreibung:   "<text>" wird auf der Titelseite vor dem Inhalt von
                 !program ausgegeben. "<text>" wird darüber hinaus
                 noch zur Darstellung von Kopfzeilen bei einigen
                 Formaten herangezogen.

 Beispiel:       !title Die Anleitung zu

 Siehe auch:     !maketitle, Titelseite


F.17.11  !toc
-------------

Inhaltsverzeichnis alleine ausgeben

 Typ & Position: Kommando, Hauptteil

 Syntax:         !toc [<kürzel>]

 Beschreibung:   Gibt ein komplettes Inhaltsverzeichnis aus. Im
                 Gegensatz zu !tableofcontents wird dabei bei Hyper-
                 textformaten keine eigene Seite erzeugt. Im Beispiel
                 würde das Inhaltsverzeichnis bei der Umwandlung ins
                 ST-Guide-Format ausgegeben.

 Beispiel:       !toc [stg]

 Siehe auch:     !tableofcontents, !subtoc, !subsubtoc, Inhaltsver-
                 zeichnisse


F.17.12  !toc_offset
--------------------

Offset für die Kapitelnumerierung setzen

 Typ & Position: Schalter, Vorspann

 Syntax:         !toc_offset <wert>

 Beschreibung:   "<wert>" wird bei der Ausgabe der Kapitelnummern zu
                 der aktuellen Nummer hinzugezählt. Im Beispiel würde
                 das erste Kapitel mit der Nummer 10 ausgegeben.
                 Dieser Schalter hat keine Wirkung auf Kapitel des
                 Anhangs

 Beispiel:       !toc_offset 9


F.17.13  !town
--------------

Wohnort des Autors für den Adressblock der Titelseite setzen

 Typ & Position: Kommando, Vorspann

 Syntax:         !town <text>

 Beschreibung:   "<text>" wird auf der Titelseite unterhalb der
                 Straße des Autors ausgegeben. Ansonsten findet
                 "<text>" keine weitere Verwendung.

 Beispiel:       !town D-59846 Sundern

 Siehe auch:     !maketitle, !street, Titelseite


F.17.14  (!T)...(!t)
--------------------

Text in Schreibmaschinenschrift ausgeben-

 Typ & Position: Platzhalter, Vorspann & Hauptteil

 Syntax:         (!T)<text>(!t)

 Beschreibung:   "<text>" wird in Schreibmaschinenschrift
                 dargestellt, falls möglich. Diese Schriftart wird
                 von fast allen Ausgabeformaten unterstützt.

 Beispiel:       (!T)monospaced(!t)

 Siehe auch:     Texthervorhebungen


F.17.15  (!TeX)
---------------

TeX-Schriftzug ausgeben.

 Typ & Position: Platzhalter, Vorspann & Hauptteil

 Syntax:         (!TeX)

 Beschreibung:   Dieser Platzhalter wird bei der Umwandlung ins
                 LaTeX-Format in \TeX{}, ansonsten in "TeX"
                 umgewandelt.

 Beispiel:       Aus (!TeX) wird TeX.

 Siehe auch:     (!LaTeX), (!LaTeXe)


F.17.16  (!today)
-----------------

Systemdatum in langer Schreibweise ausgeben.

 Typ & Position: Platzhalter, Vorspann & Hauptteil

 Syntax:         (!today)

 Beschreibung:   Dieser Platzhalter wird durch das bei der Umwandlung
                 aktuelle Systemdatum in langer Form ersetzt.

 Beispiel:       Aus (!today) wird 8. April 1996

 Siehe auch:     !german, !english, (!short_today)


F.18  U...
==========


F.18.1  !use_about_udo
----------------------

Informationsseite einbauen

 Typ & Position: Schalter, Vorspann

 Syntax:         !use_about_udo [...]

 Beschreibung:   Die Benutzung dieses Schalters erzeugt am Ende der
                 erzeugten Datei (sofern das zugehörige Format als
                 Parameter übergeben wurde) eine kleine Seite mit
                 Informationen zu UDO. Wer ein bißchen Werbung für
                 UDO machen möchte, sollte dieses Kommando im
                 Vorspann einsetzen und im Quelltext das Wort "UDO5"
                 einmal unterbringen. Danke!

 Beispiel:       !use_about_udo [stg,win]


F.18.2  !use_ansi_tables
------------------------

Tabellen mit ANSI-Grafikzeichen erzeugen

 Typ & Position: Schalter, Vorspann

 Syntax:         !use_ansi_tables [<kürzel>]

 Beschreibung:   Wird dieser Schalter im Vorspann eingesetzt, so
                 werden bei den angegebenen Formaten die Tabellen mit
                 den Grafikzeichen aus dem DOS-Zeichensatz erzeugt.
                 Der Schalter ist wirkungslos für LaTeX, WinHelp und
                 HTML

 Beispiel:       !use_ansi_tables [stg]

 Siehe auch:     !begin_table, Tabellen


F.18.3  !use_auto_subsubtocs
----------------------------

Automatische Auflistung aller Unterabschnitte

 Typ & Position: Kommando, Vorspann

 Syntax:         !use_auto_subsubtocs [<kürzel>]

 Beschreibung:   Schaltet den automatischen internen Aufruf des
                 !subsubtoc-Kommandos ein. Am Ende eines jeden
                 Abschnitts werden dann automatisch alle dem
                 Abschnitt zugehörigen Unterabschnitte in Form eines
                 Inhaltsverzeichnisses ausgegeben.

 Beispiel:       !use_auto_subsubtocs [html,pch,stg,win]

 Siehe auch:     !subsubtoc, Inhaltsverzeichnisse


F.18.4  !use_auto_subtocs
-------------------------

Automatische Auflistung aller Abschnitte

 Typ & Position: Kommando, Vorspann

 Syntax:         !use_auto_subtocs [<kürzel>]

 Beschreibung:   Schaltet den automatischen internen Aufruf des
                 !subtoc-Kommandos ein. Am Ende eines jeden Kapitels
                 werden dann automatisch alle dem Kapitel zugehörigen
                 Abschnitte in Form eines Inhaltsverzeichnisses
                 ausgegeben.

 Beispiel:       !use_auto_subtocs [html,pch,stg,win]

 Siehe auch:     !subtoc, Inhaltsverzeichnisse


F.18.5  !use_chapter_images
---------------------------

Kapitelgrafiken statt -text benutzen

 Typ & Position: Schalter, Vorspann

 Syntax:         !use_chapter_images [<kürzel>]

 Beschreibung:   Gibt an, ob für die angegebenen Formate Grafiken
                 anstelle von Kapitelüberschriften werden sollen,
                 falls bei einem Kapitel !chapterimage benutzt wird
                 und die angegebene Datei vorhanden ist.

 Beispiel:       !use_chapter_images [html,win,stg]

 Siehe auch:     !chapterimage


F.18.6  !use_formfeed
---------------------

Formfeed-Befehl mit ausgeben

 Typ & Position: Schalter, Vorspann

 Syntax:         !use_formfeed [<kürzel>]

 Beschreibung:   Mit diesem Schalter kann man UDO mitteilen, daß beim
                 !newpage-Befehl ein Formfeed (ASCII 12) ausgegeben
                 werden soll.

 Beispiel:       !use_formfeed [asc]

 Siehe auch:     !man_lpp, !newpage


F.18.7  !use_short_toc
----------------------

Kurze Inhaltsverzeichnisse benutzen

 Typ & Position: Kommando, Vorspann

 Syntax:         !use_short_toc [<kürzel>]

 Beschreibung:   Wird dieses Kommando im Vorspann benutzt, so wird
                 für die angegebenen Ausgabeformate ein kurzes In-
                 haltsverzeichnis erzeugt. Im Haupt-Inhaltsver-
                 zeichnis werden nur die Kapitelnamen und in Kapiteln
                 nur die Namen der Abschnitte ausgegeben. Im Beispiel
                 würde dies für alle Ausgabeformate getan.

 Beispiel:       !use_short_toc [all]

 Siehe auch:     !tableofcontents, Inhaltsverzeichnisse


F.18.8  !use_style_book
-----------------------

Zieldatei als "Buch" ausgeben

 Typ & Position: Schalter, Vorspann

 Syntax:         !use_style_book [<kürzel>]

 Beschreibung:   UDO gibt bei der Umwandlung ins LaTeX-Format !node's
                 mit \chapter anstatt \section, !subnode's mit
                 \section anstatt \subsection und !subsubnode's mit
                 \subsection anstatt \subsubsection aus. Bei den
                 anderen Formaten wird eine LaTeX-ähnliche Ausgabe
                 erzeugt, d.h. Kapitel werden auch mit "Kapitel #:"
                 beschriftet.

 Beispiel:       !use_style_book [tex]


F.18.9  (!U)...(!u)
-------------------

Unterstrichenen Text ausgeben

 Typ & Position: Platzhalter, Vorspann & Hauptteil

 Syntax:         (!U)<text>(!u)

 Beschreibung:   "<text>" wird unterstrichen dargestellt, falls
                 möglich. Diese Schriftart sollte sparsam eingesetzt
                 werden.

 Beispiel:       (!U)unterstrichen(!u)

 Siehe auch:     Texthervorhebungen


F.19  V...
==========


F.19.1  !verbatim_no_umlaute
----------------------------

Keine Umlaute in verbatim-Umgebungen verwenden

 Typ & Position: Schalter, Vorspann

 Syntax:         !verbatim_no_umlaute [<kürzel>]

 Beschreibung:   Umlaute, die im Quelltext innerhalb einer verbatim-
                 Umgebung vorkommen, werden in der Zieldatei durch
                 ae, oe, ue, ss, Ae, Oe und Ue ausgegeben. Im
                 Beispiel würde dies bei der Umwandlung ins LaTeX-
                 Format geschehen.

 Beispiel:       !verbatim_no_umlaute [tex]

 Siehe auch:     !begin_verbatim, !end_verbatim, Vorformatierter Text


F.19.2  !version
----------------

Versionsnummer des Programms für die Titelseite setzen

 Typ & Position: Kommando, Vorspann

 Syntax:         !version <text>

 Beschreibung:   "<text>" wird unterhalb des Programmnamens auf der
                 Titelseite ausgegeben. Ansonsten findet "<text>"
                 keine weitere Verwendung.

 Beispiel:       !version Release 5

 Siehe auch:     !maketitle, Titelseite


F.19.3  !vinclude
-----------------

Datei 1:1 einbinden

 Typ & Position: Kommando, Hauptteil

 Syntax:         !vinclude <datei>

 Beschreibung:   Öffnet die Datei "<datei>" und gibt deren Inhalt als
                 Klartext an der Stelle aus, an der dieses Kommando
                 benutzt wurde. Etwaige Einrückungen werden dabei
                 berücksichtigt, Zentrierungen jedoch nicht.

 Siehe auch:     !include, Verteilte Dokumente, Verbatim-Umgebung


F.19.4  (!V)...(!v)
-------------------

Klartext ausgeben

 Typ & Position: Platzhalter, Vorspann & Hauptteil

 Syntax:         (!V)<text>(!v)

 Beschreibung:   "<text>" wird als Klartext dargestellt, falls
                 möglich. Für LaTeX wird \verb+<text>+ ausgegeben,
                 bei allen anderen Formaten erfolgt die gleiche
                 Ausgabe wie bei (!T)...(!t).

 Beispiel:       (!V)Klartext(!v)

 Siehe auch:     Texthervorhebungen, !tex_verb


F.20  W...
==========


F.20.1  !=win
-------------

Zeile nicht beim WinHelp-Format ausgeben.

 Typ & Position: Kommando, Vorspann & Hauptteil

 Syntax:         !=win <text>

 Beschreibung:   <text> wird nur dann ausgegeben, wenn die Quelldatei
                 nicht ins WinHelp-Format umgewandelt wird. <text>
                 wird dann 1:1 und ohne Berücksichtigung etwaiger
                 UDO-Kommandos ausgegeben. Diese Zeile zerteilt
                 Absätze genau wie alle anderen Kommandos.

 Siehe auch:     !win, !ifdest, Formatspezifisches, raw-Umgebung


F.20.2  !win
------------

Zeile für WinHelp ausgeben

 Typ & Position: Kommando, Vorspann & Hauptteil

 Syntax:         !win <text>

 Beschreibung:   <text> wird nur dann ausgegeben, wenn die Quelldatei
                 ins WinHelp-Format umgewandelt wird. <text> wird
                 dann 1:1 und ohne Berücksichtigung etwaiger UDO-
                 Kommandos ausgegeben. Diese Zeile zerteilt Absätze
                 genau wie alle anderen Kommandos.

 Siehe auch:     !=win, Formatspezifisches, raw-Umgebung


F.20.3  !win_html_look
----------------------

WinHelp-Files im HTML-Look ausgeben

 Typ & Position: Schalter, Vorspann

 Syntax:         !win_html_look

 Beschreibung:   Wird dieser Schalter im Vorspann benutzt, so werden
                 WinHelp-Files in Times New Roman 11pt auf hellgrauem
                 Hintergrund ausgegeben. Damit wird versucht, einen
                 WinHelp-Hypertext wie ein HTML-Dokument ausschauen
                 zu lassen. Als Voreinstellung benutzt UDO Arial 10pt
                 und einen weißen Hintergrund.


F.20.4  !win_propfont
---------------------

Proportional-Font für WinHelp setzen

 Typ & Position: Kommando, Vorspann

 Syntax:         !win_propfont <fontname>

 Beschreibung:   Mit diesem Kommando kann man den Font setzen, der
                 zur Darstellung des Hilfstextes einer Windows-Hilfe-
                 Datei benutzt werden soll. Als Default verwendet UDO
                 den Font "Arial" (bzw. Times New Roman bei
                 !win_html_look).

 Beispiel:       !win_propfont Times New Roman

 Siehe auch:     !win_html_look


F.21  X...
==========


F.21.1  (!xlink ...)
--------------------

Verweis auf externe Daten

 Typ & Position: Platzhalter, Hauptteil

 Syntax:         (!xlink [<text>] [<link>])

 Beschreibung:   Dient zum Erzeugen von Verweisen auf externe
                 Dokumente. Im Unterschied zu (!link) werden
                 Sonderzeichen innerhalb "<link>" nicht umgewandelt.
                 Im Beispiel würde bei einem HTML-File ein
                 Querverweis auf die Seite der Deutschen Telekom
                 erzeugt.

 Beispiel:       (!xlink [Deutsche Telekom] [http://www.dtag.de])

 Siehe auch:     (!link ...), (!plink ...), !no_xlinks, Querverweise



Anhang

UDO5
****

                    Dieser Text wurde erzeugt mit

                                 UDO

                              Release 5
                          Version 0.48 TOS

                     Copyright (c) 1995, 1996 by
                            Dirk Hagedorn
                          In der Esmecke 9
                           D-59846 Sundern
                     MausNet: Dirk Hagedorn@MK2
                  America Online: [e-mail]

UDO ist ein Programm, welches Textdateien, die im Universal Document
Format erstellt wurden, in das ASCII-, ST-Guide-, LaTeX-, Rich Text-,
Pure-C-Help-, Manualpage-, HTML-, WinHelp-, Texinfo-, Linuxdoc-SGML-
            und Turbo-Vision-Help-Format umwandeln kann.

  Weitere Informationen sowie die aktuellen Versionen findet man im
                        World Wide Web unter
             http://members.aol.com/DirkHage/www/udo.htm